@fgv/ts-random 5.1.0-8

package/docs/interfaces/IPseudoRandomGeneratorCreateParams.md

@@ -0,0 +1,78 @@
+[Home](../README.md) > IPseudoRandomGeneratorCreateParams
+
+# Interface: IPseudoRandomGeneratorCreateParams
+
+Parameters for creating a generator.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[seed](./IPseudoRandomGeneratorCreateParams.seed.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string | number
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[step](./IPseudoRandomGeneratorCreateParams.step.md)
+
+</td><td>
+
+
+
+</td><td>
+
+[RandomStepFunction](../type-aliases/RandomStepFunction.md)
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[global](./IPseudoRandomGeneratorCreateParams.global.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/IPseudoRandomGeneratorCreateParams.seed.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [IPseudoRandomGeneratorCreateParams](./IPseudoRandomGeneratorCreateParams.md) > seed
+
+## IPseudoRandomGeneratorCreateParams.seed property
+
+**Signature:**
+
+```typescript
+seed: string | number;
+```

package/docs/interfaces/IPseudoRandomGeneratorCreateParams.step.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [IPseudoRandomGeneratorCreateParams](./IPseudoRandomGeneratorCreateParams.md) > step
+
+## IPseudoRandomGeneratorCreateParams.step property
+
+**Signature:**
+
+```typescript
+step: RandomStepFunction;
+```

package/docs/interfaces/IRandomSequencePickParams.candidates.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [IRandomSequencePickParams](./IRandomSequencePickParams.md) > candidates
+
+## IRandomSequencePickParams.candidates property
+
+**Signature:**
+
+```typescript
+candidates: readonly T[];
+```

package/docs/interfaces/IRandomSequencePickParams.count.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [IRandomSequencePickParams](./IRandomSequencePickParams.md) > count
+
+## IRandomSequencePickParams.count property
+
+**Signature:**
+
+```typescript
+count: number;
+```

package/docs/interfaces/IRandomSequencePickParams.how.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [IRandomSequencePickParams](./IRandomSequencePickParams.md) > how
+
+## IRandomSequencePickParams.how property
+
+**Signature:**
+
+```typescript
+how: "random";
+```

package/docs/interfaces/IRandomSequencePickParams.md

@@ -0,0 +1,79 @@
+[Home](../README.md) > IRandomSequencePickParams
+
+# Interface: IRandomSequencePickParams
+
+Parameters for generating a sequence of values
+by randomly selecting from dictionaries in a supplied set.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[how](./IRandomSequencePickParams.how.md)
+
+</td><td>
+
+
+
+</td><td>
+
+"random"
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[count](./IRandomSequencePickParams.count.md)
+
+</td><td>
+
+
+
+</td><td>
+
+number
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[candidates](./IRandomSequencePickParams.candidates.md)
+
+</td><td>
+
+
+
+</td><td>
+
+readonly T[]
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/ISeedPair.md

@@ -0,0 +1,61 @@
+[Home](../README.md) > ISeedPair
+
+# Interface: ISeedPair
+
+Represents a seed as both a string and a number.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[seed](./ISeedPair.seed.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[state](./ISeedPair.state.md)
+
+</td><td>
+
+
+
+</td><td>
+
+number
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/ISeedPair.seed.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ISeedPair](./ISeedPair.md) > seed
+
+## ISeedPair.seed property
+
+**Signature:**
+
+```typescript
+seed: string;
+```

package/docs/interfaces/ISeedPair.state.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ISeedPair](./ISeedPair.md) > state
+
+## ISeedPair.state property
+
+**Signature:**
+
+```typescript
+state: number;
+```

package/docs/interfaces/ISeededRandomSourceConstructorParams.counter.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ISeededRandomSourceConstructorParams](./ISeededRandomSourceConstructorParams.md) > counter
+
+## ISeededRandomSourceConstructorParams.counter property
+
+**Signature:**
+
+```typescript
+counter: number;
+```

package/docs/interfaces/ISeededRandomSourceConstructorParams.lineage.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ISeededRandomSourceConstructorParams](./ISeededRandomSourceConstructorParams.md) > lineage
+
+## ISeededRandomSourceConstructorParams.lineage property
+
+**Signature:**
+
+```typescript
+lineage: readonly string[];
+```

package/docs/interfaces/ISeededRandomSourceConstructorParams.md

@@ -0,0 +1,112 @@
+[Home](../README.md) > ISeededRandomSourceConstructorParams
+
+# Interface: ISeededRandomSourceConstructorParams
+
+Constructor params for a Generator.SeededRandomSource | SeededRandomSource.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[state](./ISeededRandomSourceConstructorParams.state.md)
+
+</td><td>
+
+
+
+</td><td>
+
+number
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[seed](./ISeededRandomSourceConstructorParams.seed.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[counter](./ISeededRandomSourceConstructorParams.counter.md)
+
+</td><td>
+
+
+
+</td><td>
+
+number
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[lineage](./ISeededRandomSourceConstructorParams.lineage.md)
+
+</td><td>
+
+
+
+</td><td>
+
+readonly string[]
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[step](./ISeededRandomSourceConstructorParams.step.md)
+
+</td><td>
+
+
+
+</td><td>
+
+[RandomStepFunction](../type-aliases/RandomStepFunction.md)
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/ISeededRandomSourceConstructorParams.seed.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ISeededRandomSourceConstructorParams](./ISeededRandomSourceConstructorParams.md) > seed
+
+## ISeededRandomSourceConstructorParams.seed property
+
+**Signature:**
+
+```typescript
+seed: string;
+```

package/docs/interfaces/ISeededRandomSourceConstructorParams.state.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ISeededRandomSourceConstructorParams](./ISeededRandomSourceConstructorParams.md) > state
+
+## ISeededRandomSourceConstructorParams.state property
+
+**Signature:**
+
+```typescript
+state: number;
+```

package/docs/interfaces/ISeededRandomSourceConstructorParams.step.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ISeededRandomSourceConstructorParams](./ISeededRandomSourceConstructorParams.md) > step
+
+## ISeededRandomSourceConstructorParams.step property
+
+**Signature:**
+
+```typescript
+step: RandomStepFunction;
+```

package/docs/interfaces/ISeededRandomSourceCreateParams.md

@@ -0,0 +1,61 @@
+[Home](../README.md) > ISeededRandomSourceCreateParams
+
+# Interface: ISeededRandomSourceCreateParams
+
+Static create parameters for a Generator.SeededRandomSource | SeededRandomSource.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[seed](./ISeededRandomSourceCreateParams.seed.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string | number
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[step](./ISeededRandomSourceCreateParams.step.md)
+
+</td><td>
+
+
+
+</td><td>
+
+[RandomStepFunction](../type-aliases/RandomStepFunction.md)
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/ISeededRandomSourceCreateParams.seed.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ISeededRandomSourceCreateParams](./ISeededRandomSourceCreateParams.md) > seed
+
+## ISeededRandomSourceCreateParams.seed property
+
+**Signature:**
+
+```typescript
+seed: string | number;
+```

package/docs/interfaces/ISeededRandomSourceCreateParams.step.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ISeededRandomSourceCreateParams](./ISeededRandomSourceCreateParams.md) > step
+
+## ISeededRandomSourceCreateParams.step property
+
+**Signature:**
+
+```typescript
+step: RandomStepFunction;
+```

package/docs/interfaces/ISequentialPickParams.candidates.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ISequentialPickParams](./ISequentialPickParams.md) > candidates
+
+## ISequentialPickParams.candidates property
+
+**Signature:**
+
+```typescript
+candidates: readonly (readonly T[])[];
+```

package/docs/interfaces/ISequentialPickParams.count.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ISequentialPickParams](./ISequentialPickParams.md) > count
+
+## ISequentialPickParams.count property
+
+**Signature:**
+
+```typescript
+count: number;
+```

package/docs/interfaces/ISequentialPickParams.how.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ISequentialPickParams](./ISequentialPickParams.md) > how
+
+## ISequentialPickParams.how property
+
+**Signature:**
+
+```typescript
+how: "sequence";
+```

package/docs/interfaces/ISequentialPickParams.md

@@ -0,0 +1,79 @@
+[Home](../README.md) > ISequentialPickParams
+
+# Interface: ISequentialPickParams
+
+Parameters for generating a sequence of values
+from each dictionary in a supplied set, in turn.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[how](./ISequentialPickParams.how.md)
+
+</td><td>
+
+
+
+</td><td>
+
+"sequence"
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[count](./ISequentialPickParams.count.md)
+
+</td><td>
+
+
+
+</td><td>
+
+number
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[candidates](./ISequentialPickParams.candidates.md)
+
+</td><td>
+
+
+
+</td><td>
+
+readonly (readonly T[])[]
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/type-aliases/GeneratorGlobalThis.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > GeneratorGlobalThis
+
+# Type Alias: GeneratorGlobalThis
+
+Global context (globalThis) into which the generator can install itself for sharing.
+
+## Type
+
+```typescript
+type GeneratorGlobalThis = unknown
+```

package/docs/type-aliases/RandomStepFunction.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > RandomStepFunction
+
+# Type Alias: RandomStepFunction
+
+Function that steps a random number generator state and returns the next value.
+
+## Type
+
+```typescript
+type RandomStepFunction = (state: number) => INextResult
+```

package/docs/type-aliases/SequencePickParams.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > SequencePickParams
+
+# Type Alias: SequencePickParams
+
+Type representing parameters for generating a sequence of values.
+
+## Type
+
+```typescript
+type SequencePickParams = ISequentialPickParams<T> | IRandomSequencePickParams<T>
+```

package/docs/variables/Adjectives.md

@@ -0,0 +1,7 @@
+[Home](../README.md) > Adjectives
+
+# Variable: Adjectives
+
+## Type
+
+`ReadonlyArray<string>`