@fgv/ts-random 5.1.0-19 → 5.1.0-21

package/docs/Words/README.md

@@ -1,125 +0,0 @@
-[Home](../README.md) > Words
-
-# Namespace: Words
-
-## Variables
-
-<table><thead><tr><th>
-
-Name
-
-</th><th>
-
-Description
-
-</th></tr></thead>
-<tbody>
-<tr><td>
-
-[Adjectives](./variables/Adjectives.md)
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[Animals](./variables/Animals.md)
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[Cities](./variables/Cities.md)
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[Colors](./variables/Colors.md)
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[Countries](./variables/Countries.md)
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[Domains](./variables/Domains.md)
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[Gerunds](./variables/Gerunds.md)
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[jobs](./variables/jobs.md)
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[FirstNamesMale](./variables/FirstNamesMale.md)
-
-</td><td>
-
-Male first names
-
-</td></tr>
-<tr><td>
-
-[FirstNamesFemale](./variables/FirstNamesFemale.md)
-
-</td><td>
-
-Female first names
-
-</td></tr>
-<tr><td>
-
-[FirstNames](./variables/FirstNames.md)
-
-</td><td>
-
-All first names
-
-</td></tr>
-<tr><td>
-
-[FamilyNames](./variables/FamilyNames.md)
-
-</td><td>
-
-Family names / surnames
-
-</td></tr>
-</tbody></table>

package/docs/Words/variables/Adjectives.md

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

package/docs/Words/variables/Animals.md

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

package/docs/Words/variables/Cities.md

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

package/docs/Words/variables/Colors.md

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

package/docs/Words/variables/Countries.md

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

package/docs/Words/variables/Domains.md

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

package/docs/Words/variables/FamilyNames.md

@@ -1,9 +0,0 @@
-[Home](../../README.md) > [Words](../README.md) > FamilyNames
-
-# Variable: FamilyNames
-
-Family names / surnames
-
-## Type
-
-`ReadonlyArray<string>`

package/docs/Words/variables/FirstNames.md

@@ -1,9 +0,0 @@
-[Home](../../README.md) > [Words](../README.md) > FirstNames
-
-# Variable: FirstNames
-
-All first names
-
-## Type
-
-`ReadonlyArray<string>`

package/docs/Words/variables/FirstNamesFemale.md

@@ -1,9 +0,0 @@
-[Home](../../README.md) > [Words](../README.md) > FirstNamesFemale
-
-# Variable: FirstNamesFemale
-
-Female first names
-
-## Type
-
-`ReadonlyArray<string>`

package/docs/Words/variables/FirstNamesMale.md

@@ -1,9 +0,0 @@
-[Home](../../README.md) > [Words](../README.md) > FirstNamesMale
-
-# Variable: FirstNamesMale
-
-Male first names
-
-## Type
-
-`ReadonlyArray<string>`

package/docs/Words/variables/Gerunds.md

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

package/docs/Words/variables/jobs.md

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

package/docs/classes/PseudoRandomGenerator.clone.md

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

package/docs/classes/PseudoRandomGenerator.create.md

@@ -1,24 +0,0 @@
-[Home](../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](PseudoRandomGenerator.md)&gt;
-
-A result containing the new generator or an error.

package/docs/classes/PseudoRandomGenerator.createChild.md

@@ -1,24 +0,0 @@
-[Home](../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](PseudoRandomGenerator.md)
-
-A new generator with the given label.

package/docs/classes/PseudoRandomGenerator.ensureRng.md

@@ -1,25 +0,0 @@
-[Home](../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): Result<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:**
-
-Result&lt;[PseudoRandomGenerator](PseudoRandomGenerator.md)&gt;
-
-A random number generator.

package/docs/classes/PseudoRandomGenerator.getGlobalRng.md

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

package/docs/classes/PseudoRandomGenerator.md

@@ -1,258 +0,0 @@
-[Home](../README.md) > PseudoRandomGenerator
-
-# Class: PseudoRandomGenerator
-
-A pseudo-random number generator that can be used to generate random values
-of various shapes.
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-</th><th>
-
-Modifiers
-
-</th><th>
-
-Type
-
-</th><th>
-
-Description
-
-</th></tr></thead>
-<tbody>
-<tr><td>
-
-[rng](./PseudoRandomGenerator.rng.md)
-
-</td><td>
-
-`readonly`
-
-</td><td>
-
-[SeededRandomSource](SeededRandomSource.md)
-
-</td><td>
-
-The underlying random number generator.
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-</th><th>
-
-Modifiers
-
-</th><th>
-
-Description
-
-</th></tr></thead>
-<tbody>
-<tr><td>
-
-[create(params)](./PseudoRandomGenerator.create.md)
-
-</td><td>
-
-`static`
-
-</td><td>
-
-Creates a new pseudo-random number generator.
-
-</td></tr>
-<tr><td>
-
-[setGlobalRng(rng)](./PseudoRandomGenerator.setGlobalRng.md)
-
-</td><td>
-
-`static`
-
-</td><td>
-
-Sets this generator as the global random number generator.
-
-</td></tr>
-<tr><td>
-
-[getGlobalRng()](./PseudoRandomGenerator.getGlobalRng.md)
-
-</td><td>
-
-`static`
-
-</td><td>
-
-Gets the global random number generator.
-
-</td></tr>
-<tr><td>
-
-[ensureRng(rng)](./PseudoRandomGenerator.ensureRng.md)
-
-</td><td>
-
-`static`
-
-</td><td>
-
-Ensures a random number generator is available, using the global generator if available
-
-</td></tr>
-<tr><td>
-
-[clone()](./PseudoRandomGenerator.clone.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Creates a clone of this generator.
-
-</td></tr>
-<tr><td>
-
-[createChild(label)](./PseudoRandomGenerator.createChild.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Creates a child generator with the given label.
-
-</td></tr>
-<tr><td>
-
-[nextFloat()](./PseudoRandomGenerator.nextFloat.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Generates a random float between 0 and 1.
-
-</td></tr>
-<tr><td>
-
-[nextInt(extent)](./PseudoRandomGenerator.nextInt.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Generates a random integer between 0 and the specified extent (positive or negative).
-
-</td></tr>
-<tr><td>
-
-[nextInRange(min, max)](./PseudoRandomGenerator.nextInRange.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Generates a random integer between the specified minimum and maximum values.
-
-</td></tr>
-<tr><td>
-
-[nextBoolean(trueProbability)](./PseudoRandomGenerator.nextBoolean.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Generates a random boolean value.
-
-</td></tr>
-<tr><td>
-
-[nextString(length, chars)](./PseudoRandomGenerator.nextString.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Generates a random string of the specified length using the given characters.
-
-</td></tr>
-<tr><td>
-
-[pickNext(items)](./PseudoRandomGenerator.pickNext.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Generates a random item from the given array.
-
-</td></tr>
-<tr><td>
-
-[pickSequential(params)](./PseudoRandomGenerator.pickSequential.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Generates a sequence of values by randomly selecting from the given candidate
-
-</td></tr>
-<tr><td>
-
-[pickRandom(params)](./PseudoRandomGenerator.pickRandom.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Generates a sequence of values by randomly selecting from the supplied
-
-</td></tr>
-<tr><td>
-
-[pickSequence(params)](./PseudoRandomGenerator.pickSequence.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Generates a sequence of values by randomly selecting from the given candidates.
-
-</td></tr>
-</tbody></table>

package/docs/classes/PseudoRandomGenerator.nextBoolean.md

@@ -1,24 +0,0 @@
-[Home](../README.md) > [PseudoRandomGenerator](./PseudoRandomGenerator.md) > nextBoolean
-
-## PseudoRandomGenerator.nextBoolean() method
-
-Generates a random boolean value.
-
-**Signature:**
-
-```typescript
-nextBoolean(trueProbability: number): boolean;
-```
-
-**Parameters:**
-
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>trueProbability</td><td>number</td><td>The probability of returning true (default is 0.5).</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-
-A random boolean value.

package/docs/classes/PseudoRandomGenerator.nextFloat.md

@@ -1,17 +0,0 @@
-[Home](../README.md) > [PseudoRandomGenerator](./PseudoRandomGenerator.md) > nextFloat
-
-## PseudoRandomGenerator.nextFloat() method
-
-Generates a random float between 0 and 1.
-
-**Signature:**
-
-```typescript
-nextFloat(): number;
-```
-
-**Returns:**
-
-number
-
-A random float between 0 and 1.

package/docs/classes/PseudoRandomGenerator.nextInRange.md

@@ -1,25 +0,0 @@
-[Home](../README.md) > [PseudoRandomGenerator](./PseudoRandomGenerator.md) > nextInRange
-
-## PseudoRandomGenerator.nextInRange() method
-
-Generates a random integer between the specified minimum and maximum values.
-
-**Signature:**
-
-```typescript
-nextInRange(min: number | undefined, max: number | undefined): number;
-```
-
-**Parameters:**
-
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>min</td><td>number | undefined</td><td>The minimum value (inclusive).</td></tr>
-<tr><td>max</td><td>number | undefined</td><td>The maximum value (inclusive).</td></tr>
-</tbody></table>
-
-**Returns:**
-
-number
-
-A random integer between the specified minimum and maximum values.

package/docs/classes/PseudoRandomGenerator.nextInt.md

@@ -1,24 +0,0 @@
-[Home](../README.md) > [PseudoRandomGenerator](./PseudoRandomGenerator.md) > nextInt
-
-## PseudoRandomGenerator.nextInt() method
-
-Generates a random integer between 0 and the specified extent (positive or negative).
-
-**Signature:**
-
-```typescript
-nextInt(extent?: number): number;
-```
-
-**Parameters:**
-
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>extent</td><td>number</td><td>The maximum (or minimum) value (exclusive).</td></tr>
-</tbody></table>
-
-**Returns:**
-
-number
-
-A random integer between 0 and the specified extent.