@fgv/ts-random 5.1.0-8

package/config/jest.config.json

@@ -0,0 +1,13 @@
+{
+  "extends": "@rushstack/heft-node-rig/profiles/default/config/jest.config.json",
+  "coverageThreshold": {
+    "global": {
+      "branches": 100,
+      "functions": 100,
+      "lines": 100,
+      "statements": 100
+    }
+  },
+  "collectCoverage": true,
+  "coverageReporters": ["text", "lcov", "html"]
+}

package/config/rig.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json",
+  "rigPackageName": "@fgv/heft-dual-rig"
+}

package/config/typedoc.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "extends": ["@fgv/heft-dual-rig/profiles/default/config/typedoc.compact-base.json"],
+  "plugin": ["../../../plugins/typedoc-compact-theme/lib/index.js"],
+  "entryPoints": ["../src/index.ts"],
+  "out": "../docs"
+}

package/docs/Chars/README.md

@@ -0,0 +1,152 @@
+[Home](../README.md) > Chars
+
+# Namespace: Chars
+
+## Variables
+
+<table><thead><tr><th>
+
+Name
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[lowerCase](./variables/lowerCase.md)
+
+</td><td>
+
+Lowercase letters
+
+</td></tr>
+<tr><td>
+
+[upperCase](./variables/upperCase.md)
+
+</td><td>
+
+Uppercase letters
+
+</td></tr>
+<tr><td>
+
+[digits](./variables/digits.md)
+
+</td><td>
+
+Digits
+
+</td></tr>
+<tr><td>
+
+[letters](./variables/letters.md)
+
+</td><td>
+
+Letters
+
+</td></tr>
+<tr><td>
+
+[alphanumeric](./variables/alphanumeric.md)
+
+</td><td>
+
+Alphanumeric
+
+</td></tr>
+<tr><td>
+
+[symbols](./variables/symbols.md)
+
+</td><td>
+
+Symbols
+
+</td></tr>
+<tr><td>
+
+[whitespace](./variables/whitespace.md)
+
+</td><td>
+
+Whitespace
+
+</td></tr>
+<tr><td>
+
+[printable](./variables/printable.md)
+
+</td><td>
+
+Printable
+
+</td></tr>
+<tr><td>
+
+[all](./variables/all.md)
+
+</td><td>
+
+All
+
+</td></tr>
+<tr><td>
+
+[hexDigits](./variables/hexDigits.md)
+
+</td><td>
+
+Hex digits
+
+</td></tr>
+<tr><td>
+
+[hexDigitsUpper](./variables/hexDigitsUpper.md)
+
+</td><td>
+
+Hex digits upper
+
+</td></tr>
+<tr><td>
+
+[hex](./variables/hex.md)
+
+</td><td>
+
+Hex
+
+</td></tr>
+<tr><td>
+
+[base64](./variables/base64.md)
+
+</td><td>
+
+Base64
+
+</td></tr>
+<tr><td>
+
+[base64Url](./variables/base64Url.md)
+
+</td><td>
+
+Base64 URL
+
+</td></tr>
+<tr><td>
+
+[base64UrlNoPadding](./variables/base64UrlNoPadding.md)
+
+</td><td>
+
+Base64 URL no padding
+
+</td></tr>
+</tbody></table>

package/docs/Chars/variables/all.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Chars](../README.md) > all
+
+# Variable: all
+
+All
+
+## Type
+
+`string`

package/docs/Chars/variables/alphanumeric.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Chars](../README.md) > alphanumeric
+
+# Variable: alphanumeric
+
+Alphanumeric
+
+## Type
+
+`string`

package/docs/Chars/variables/base64.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Chars](../README.md) > base64
+
+# Variable: base64
+
+Base64
+
+## Type
+
+`string`

package/docs/Chars/variables/base64Url.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Chars](../README.md) > base64Url
+
+# Variable: base64Url
+
+Base64 URL
+
+## Type
+
+`string`

package/docs/Chars/variables/base64UrlNoPadding.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Chars](../README.md) > base64UrlNoPadding
+
+# Variable: base64UrlNoPadding
+
+Base64 URL no padding
+
+## Type
+
+`string`

package/docs/Chars/variables/digits.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Chars](../README.md) > digits
+
+# Variable: digits
+
+Digits
+
+## Type
+
+`string`

package/docs/Chars/variables/hex.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Chars](../README.md) > hex
+
+# Variable: hex
+
+Hex
+
+## Type
+
+`string`

package/docs/Chars/variables/hexDigits.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Chars](../README.md) > hexDigits
+
+# Variable: hexDigits
+
+Hex digits
+
+## Type
+
+`string`

package/docs/Chars/variables/hexDigitsUpper.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Chars](../README.md) > hexDigitsUpper
+
+# Variable: hexDigitsUpper
+
+Hex digits upper
+
+## Type
+
+`string`

package/docs/Chars/variables/letters.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Chars](../README.md) > letters
+
+# Variable: letters
+
+Letters
+
+## Type
+
+`string`

package/docs/Chars/variables/lowerCase.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Chars](../README.md) > lowerCase
+
+# Variable: lowerCase
+
+Lowercase letters
+
+## Type
+
+`string`

package/docs/Chars/variables/printable.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Chars](../README.md) > printable
+
+# Variable: printable
+
+Printable
+
+## Type
+
+`string`

package/docs/Chars/variables/symbols.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Chars](../README.md) > symbols
+
+# Variable: symbols
+
+Symbols
+
+## Type
+
+`string`

package/docs/Chars/variables/upperCase.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Chars](../README.md) > upperCase
+
+# Variable: upperCase
+
+Uppercase letters
+
+## Type
+
+`string`

package/docs/Chars/variables/whitespace.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Chars](../README.md) > whitespace
+
+# Variable: whitespace
+
+Whitespace
+
+## Type
+
+`string`

package/docs/Generator/README.md

@@ -0,0 +1,153 @@
+[Home](../README.md) > Generator
+
+# Namespace: Generator
+
+## Classes
+
+<table><thead><tr><th>
+
+Name
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[SeededRandomSource](./classes/SeededRandomSource.md)
+
+</td><td>
+
+Seeded random number generator that can be cloned and used for deterministic generation.
+
+</td></tr>
+<tr><td>
+
+[PseudoRandomGenerator](./classes/PseudoRandomGenerator.md)
+
+</td><td>
+
+A pseudo-random number generator that can be used to generate random values
+
+</td></tr>
+</tbody></table>
+
+## Interfaces
+
+<table><thead><tr><th>
+
+Name
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[ISeedPair](./interfaces/ISeedPair.md)
+
+</td><td>
+
+Represents a seed as both a string and a number.
+
+</td></tr>
+<tr><td>
+
+[INextResult](./interfaces/INextResult.md)
+
+</td><td>
+
+Result of an internal next() operation.
+
+</td></tr>
+<tr><td>
+
+[ISeededRandomSourceConstructorParams](./interfaces/ISeededRandomSourceConstructorParams.md)
+
+</td><td>
+
+Constructor params for a Generator.SeededRandomSource | SeededRandomSource.
+
+</td></tr>
+<tr><td>
+
+[ISeededRandomSourceCreateParams](./interfaces/ISeededRandomSourceCreateParams.md)
+
+</td><td>
+
+Static create parameters for a Generator.SeededRandomSource | SeededRandomSource.
+
+</td></tr>
+<tr><td>
+
+[IPseudoRandomGeneratorCreateParams](./interfaces/IPseudoRandomGeneratorCreateParams.md)
+
+</td><td>
+
+Parameters for creating a generator.
+
+</td></tr>
+<tr><td>
+
+[ISequentialPickParams](./interfaces/ISequentialPickParams.md)
+
+</td><td>
+
+Parameters for generating a sequence of values
+
+</td></tr>
+<tr><td>
+
+[IRandomSequencePickParams](./interfaces/IRandomSequencePickParams.md)
+
+</td><td>
+
+Parameters for generating a sequence of values
+
+</td></tr>
+</tbody></table>
+
+## Type Aliases
+
+<table><thead><tr><th>
+
+Name
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[RandomStepFunction](./type-aliases/RandomStepFunction.md)
+
+</td><td>
+
+Function that steps a random number generator state and returns the next value.
+
+</td></tr>
+<tr><td>
+
+[GeneratorGlobalThis](./type-aliases/GeneratorGlobalThis.md)
+
+</td><td>
+
+Global context (globalThis) into which the generator can install itself for sharing.
+
+</td></tr>
+<tr><td>
+
+[SequencePickParams](./type-aliases/SequencePickParams.md)
+
+</td><td>
+
+Type representing parameters for generating a sequence of values.
+
+</td></tr>
+</tbody></table>

package/docs/Generator/classes/PseudoRandomGenerator.clone.md

@@ -0,0 +1,17 @@
+[Home](../../README.md) > [Generator](../README.md) > [PseudoRandomGenerator](./PseudoRandomGenerator.md) > clone
+
+## PseudoRandomGenerator.clone() method
+
+Creates a clone of this generator.
+
+**Signature:**
+
+```typescript
+clone(): PseudoRandomGenerator;
+```
+
+**Returns:**
+
+[PseudoRandomGenerator](../../classes/PseudoRandomGenerator.md)
+
+A new generator with the same state.

package/docs/Generator/classes/PseudoRandomGenerator.create.md

@@ -0,0 +1,24 @@
+[Home](../../README.md) > [Generator](../README.md) > [PseudoRandomGenerator](./PseudoRandomGenerator.md) > create
+
+## PseudoRandomGenerator.create() method
+
+Creates a new pseudo-random number generator.
+
+**Signature:**
+
+```typescript
+static create(params?: IPseudoRandomGeneratorCreateParams): Result<PseudoRandomGenerator>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>params</td><td>IPseudoRandomGeneratorCreateParams</td><td>The parameters for creating the generator.</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Result&lt;[PseudoRandomGenerator](../../classes/PseudoRandomGenerator.md)&gt;
+
+A result containing the new generator or an error.

package/docs/Generator/classes/PseudoRandomGenerator.createChild.md

@@ -0,0 +1,24 @@
+[Home](../../README.md) > [Generator](../README.md) > [PseudoRandomGenerator](./PseudoRandomGenerator.md) > createChild
+
+## PseudoRandomGenerator.createChild() method
+
+Creates a child generator with the given label.
+
+**Signature:**
+
+```typescript
+createChild(label: string): PseudoRandomGenerator;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>label</td><td>string</td><td>The label for the child generator.</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[PseudoRandomGenerator](../../classes/PseudoRandomGenerator.md)
+
+A new generator with the given label.

package/docs/Generator/classes/PseudoRandomGenerator.ensureRng.md

@@ -0,0 +1,25 @@
+[Home](../../README.md) > [Generator](../README.md) > [PseudoRandomGenerator](./PseudoRandomGenerator.md) > ensureRng
+
+## PseudoRandomGenerator.ensureRng() method
+
+Ensures a random number generator is available, using the global generator if available
+or creating a new one if not.
+
+**Signature:**
+
+```typescript
+static ensureRng(rng?: PseudoRandomGenerator): PseudoRandomGenerator;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>rng</td><td>PseudoRandomGenerator</td><td>The random number generator to use, or undefined to use the global one.</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[PseudoRandomGenerator](../../classes/PseudoRandomGenerator.md)
+
+A random number generator.

package/docs/Generator/classes/PseudoRandomGenerator.getGlobalRng.md

@@ -0,0 +1,17 @@
+[Home](../../README.md) > [Generator](../README.md) > [PseudoRandomGenerator](./PseudoRandomGenerator.md) > getGlobalRng
+
+## PseudoRandomGenerator.getGlobalRng() method
+
+Gets the global random number generator.
+
+**Signature:**
+
+```typescript
+static getGlobalRng(): PseudoRandomGenerator | undefined;
+```
+
+**Returns:**
+
+[PseudoRandomGenerator](../../classes/PseudoRandomGenerator.md) | undefined
+
+The global random number generator or undefined if not set.