Files
meteor/docs/client/packages/random.html
2013-02-13 14:41:31 -08:00

35 lines
947 B
HTML

<template name="pkg_random">
{{#better_markdown}}
## `random`
The `random` package provides several functions for generating random
numbers. It uses a Meteor-provided random number generator that does not depend
on the browser's facilities.
<dl class="callbacks">
{{#dtdd "Random.id()"}}
Returns a unique identifier, such as `"Jjwjg6gouWLXhMGKW"`, that is likely to
be unique in the whole world.
{{/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}}
</dl>
{{#note}}
In the current implementation, random values do not come from a
cryptographically strong pseudorandom number generator. Future releases will
improve this, particularly on the server.
{{/note}}
{{/better_markdown}}
</template>