Document properties and options

Author: kgryte

lib/node_modules/@stdlib/random/base/hypergeometric/docs/repl.txt

@@ -52,8 +52,21 @@
     options: Object (optional)
         Options.
 
-    options.seed: any (optional)
-        Pseudorandom number generator seed.
+    options.seed: integer|ArrayLikeObject<integer> (optional)
+        Pseudorandom number generator seed. The seed may be either a positive
+        unsigned 32-bit integer or, for arbitrary length seeds, an array-like
+        object containing unsigned 32-bit integers.
+
+    options.state: Uint32Array (optional)
+        Pseudorandom number generator state. If provided, the `seed` option is
+        ignored.
+
+    options.copy: boolean (optional)
+        Boolean indicating whether to copy a provided pseudorandom number
+        generator state. Setting this option to `false` allows sharing state
+        between two or more pseudorandom number generators. Setting this option
+        to `true` ensures that a returned generator has exclusive control over
+        its internal state. Default: true.
 
     Returns
     -------
@@ -97,6 +110,61 @@
     --------
     > var seed = {{alias}}.seed;
 
+
+{{alias}}.seedLength
+    Length of generator seed.
+
+    Examples
+    --------
+    > var len = {{alias}}.seedLength;
+
+
+{{alias}}.state
+    Generator state.
+
+    Examples
+    --------
+    > var r = {{alias}}( 20, 10, 15 )
+    <number>
+    > r = {{alias}}( 20, 10, 15 )
+    <number>
+    > r = {{alias}}( 20, 10, 15 )
+    <number>
+
+    // Get a copy of the current state:
+    > var state = {{alias}}.state
+    <Uint32Array>
+
+    > r = {{alias}}( 20, 10, 15 )
+    <number>
+    > r = {{alias}}( 20, 10, 15 )
+    <number>
+
+    // Set the state:
+    > {{alias}}.state = state;
+
+    // Replay the last two pseudorandom numbers:
+    > r = {{alias}}( 20, 10, 15 )
+    <number>
+    > r = {{alias}}( 20, 10, 15 )
+    <number>
+
+
+{{alias}}.stateLength
+    Length of generator state.
+
+    Examples
+    --------
+    > var len = {{alias}}.stateLength;
+
+
+{{alias}}.byteLength
+    Size (in bytes) of generator state.
+
+    Examples
+    --------
+    > var sz = {{alias}}.byteLength;
+
     See Also
     --------