randomInt
Description
Returns a pseudorandom integer between 0 (inclusive) and an upper bound
(exclusive).
note
randomInt is not cryptographically secure.
Syntax
Like many functions in DataPrime, randomInt supports two notations, function and method. These interchangeable forms allow flexibility in how you structure expressions.
- Function notation
- Method notation
randomInt(upperBound: number): number
(upperBound: number).randomInt(): number
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
upperBound | number | true | The exclusive upper limit for the random number |
Example
Use case: Generate a random integer within a range
Create a pseudorandom integer between 0 and 99 and attach it to each document.
Example data
{
"event": "login_attempt"
}
Example query
- Function notation
- Method notation
create random_num from randomInt(100)
create random_num from 100.randomInt()
Example output
{
"event": "login_attempt",
"random_num": 57
}