Files
meteor/docs/client/full-api/packages/random.md
Tom Coleman ea4ddea6a4 Moved HTML files -> MD
(still getting compile errors on the spacebars one however...
2016-03-18 10:11:37 +11:00

1.3 KiB

{{#template name="pkg_random"}}

random

The random package provides several functions for generating random numbers. It uses a cryptographically strong pseudorandom number generator when possible, but falls back to a weaker random number generator when cryptographically strong randomness is not available (on older browsers or on servers that don't have enough entropy to seed the cryptographically strong generator).

{{#dtdd "Random.id([n])"}} Returns a unique identifier, such as `"Jjwjg6gouWLXhMGKW"`, that is likely to be unique in the whole world. The optional argument `n` specifies the length of the identifier in characters and defaults to 17. {{/dtdd}}

{{#dtdd "Random.secret([n])"}} Returns a random string of printable characters with 6 bits of entropy per character. The optional argument n specifies the length of the secret string and defaults to 43 characters, or 256 bits of entropy. Use Random.secret for security-critical secrets that are intended for machine, rather than human, consumption. {{/dtdd}}

{{#dtdd "Random.fraction()"}} Returns a number between 0 and 1, like Math.random. {{/dtdd}}

{{#dtdd "Random.choice(arrayOrString)"}} Returns a random element of the given array or string. {{/dtdd}}

{{#dtdd "Random.hexString(n)"}} Returns a random string of n hexadecimal digits. {{/dtdd}}

{{/template}}