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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (273) hide show
  1. package/package.json +6 -6
  2. package/.rush/temp/chunked-rush-logs/ts-random.build.chunks.jsonl +0 -6
  3. package/.rush/temp/fba88d771243a88edd09f745ba7194831032f604.tar.log +0 -121
  4. package/.rush/temp/operation/build/all.log +0 -6
  5. package/.rush/temp/operation/build/log-chunks.jsonl +0 -6
  6. package/.rush/temp/operation/build/state.json +0 -3
  7. package/.rush/temp/shrinkwrap-deps.json +0 -614
  8. package/config/jest.config.json +0 -13
  9. package/config/rig.json +0 -4
  10. package/config/typedoc.json +0 -7
  11. package/dist/test/unit/generators.test.js +0 -596
  12. package/dist/test/unit/generators.test.js.map +0 -1
  13. package/dist/test/unit/randomSource.test.js +0 -452
  14. package/dist/test/unit/randomSource.test.js.map +0 -1
  15. package/docs/Chars/README.md +0 -152
  16. package/docs/Chars/variables/all.md +0 -9
  17. package/docs/Chars/variables/alphanumeric.md +0 -9
  18. package/docs/Chars/variables/base64.md +0 -9
  19. package/docs/Chars/variables/base64Url.md +0 -9
  20. package/docs/Chars/variables/base64UrlNoPadding.md +0 -9
  21. package/docs/Chars/variables/digits.md +0 -9
  22. package/docs/Chars/variables/hex.md +0 -9
  23. package/docs/Chars/variables/hexDigits.md +0 -9
  24. package/docs/Chars/variables/hexDigitsUpper.md +0 -9
  25. package/docs/Chars/variables/letters.md +0 -9
  26. package/docs/Chars/variables/lowerCase.md +0 -9
  27. package/docs/Chars/variables/printable.md +0 -9
  28. package/docs/Chars/variables/symbols.md +0 -9
  29. package/docs/Chars/variables/upperCase.md +0 -9
  30. package/docs/Chars/variables/whitespace.md +0 -9
  31. package/docs/Generator/README.md +0 -144
  32. package/docs/Generator/classes/PseudoRandomGenerator.clone.md +0 -17
  33. package/docs/Generator/classes/PseudoRandomGenerator.create.md +0 -24
  34. package/docs/Generator/classes/PseudoRandomGenerator.createChild.md +0 -24
  35. package/docs/Generator/classes/PseudoRandomGenerator.ensureRng.md +0 -25
  36. package/docs/Generator/classes/PseudoRandomGenerator.getGlobalRng.md +0 -17
  37. package/docs/Generator/classes/PseudoRandomGenerator.md +0 -258
  38. package/docs/Generator/classes/PseudoRandomGenerator.nextBoolean.md +0 -24
  39. package/docs/Generator/classes/PseudoRandomGenerator.nextFloat.md +0 -17
  40. package/docs/Generator/classes/PseudoRandomGenerator.nextInRange.md +0 -25
  41. package/docs/Generator/classes/PseudoRandomGenerator.nextInt.md +0 -24
  42. package/docs/Generator/classes/PseudoRandomGenerator.nextString.md +0 -25
  43. package/docs/Generator/classes/PseudoRandomGenerator.pickNext.md +0 -24
  44. package/docs/Generator/classes/PseudoRandomGenerator.pickRandom.md +0 -25
  45. package/docs/Generator/classes/PseudoRandomGenerator.pickSequence.md +0 -24
  46. package/docs/Generator/classes/PseudoRandomGenerator.pickSequential.md +0 -25
  47. package/docs/Generator/classes/PseudoRandomGenerator.rng.md +0 -11
  48. package/docs/Generator/classes/PseudoRandomGenerator.setGlobalRng.md +0 -24
  49. package/docs/Generator/classes/SeededRandomSource.clone.md +0 -17
  50. package/docs/Generator/classes/SeededRandomSource.counter.md +0 -11
  51. package/docs/Generator/classes/SeededRandomSource.create.md +0 -24
  52. package/docs/Generator/classes/SeededRandomSource.createChild.md +0 -24
  53. package/docs/Generator/classes/SeededRandomSource.hashSeed.md +0 -24
  54. package/docs/Generator/classes/SeededRandomSource.hashStateAndLabel.md +0 -25
  55. package/docs/Generator/classes/SeededRandomSource.lineage.md +0 -9
  56. package/docs/Generator/classes/SeededRandomSource.md +0 -187
  57. package/docs/Generator/classes/SeededRandomSource.mulberryStep.md +0 -24
  58. package/docs/Generator/classes/SeededRandomSource.next.md +0 -17
  59. package/docs/Generator/classes/SeededRandomSource.seed.md +0 -9
  60. package/docs/Generator/interfaces/INextResult.md +0 -61
  61. package/docs/Generator/interfaces/INextResult.nextState.md +0 -9
  62. package/docs/Generator/interfaces/INextResult.value.md +0 -9
  63. package/docs/Generator/interfaces/IPseudoRandomGeneratorCreateParams.global.md +0 -9
  64. package/docs/Generator/interfaces/IPseudoRandomGeneratorCreateParams.md +0 -78
  65. package/docs/Generator/interfaces/IPseudoRandomGeneratorCreateParams.seed.md +0 -9
  66. package/docs/Generator/interfaces/IPseudoRandomGeneratorCreateParams.step.md +0 -9
  67. package/docs/Generator/interfaces/IRandomSequencePickParams.candidates.md +0 -9
  68. package/docs/Generator/interfaces/IRandomSequencePickParams.count.md +0 -9
  69. package/docs/Generator/interfaces/IRandomSequencePickParams.how.md +0 -9
  70. package/docs/Generator/interfaces/IRandomSequencePickParams.md +0 -79
  71. package/docs/Generator/interfaces/ISeedPair.md +0 -61
  72. package/docs/Generator/interfaces/ISeedPair.seed.md +0 -9
  73. package/docs/Generator/interfaces/ISeedPair.state.md +0 -9
  74. package/docs/Generator/interfaces/ISeededRandomSourceConstructorParams.counter.md +0 -9
  75. package/docs/Generator/interfaces/ISeededRandomSourceConstructorParams.lineage.md +0 -9
  76. package/docs/Generator/interfaces/ISeededRandomSourceConstructorParams.md +0 -112
  77. package/docs/Generator/interfaces/ISeededRandomSourceConstructorParams.seed.md +0 -9
  78. package/docs/Generator/interfaces/ISeededRandomSourceConstructorParams.state.md +0 -9
  79. package/docs/Generator/interfaces/ISeededRandomSourceConstructorParams.step.md +0 -9
  80. package/docs/Generator/interfaces/ISeededRandomSourceCreateParams.md +0 -61
  81. package/docs/Generator/interfaces/ISeededRandomSourceCreateParams.seed.md +0 -9
  82. package/docs/Generator/interfaces/ISeededRandomSourceCreateParams.step.md +0 -9
  83. package/docs/Generator/interfaces/ISequentialPickParams.candidates.md +0 -9
  84. package/docs/Generator/interfaces/ISequentialPickParams.count.md +0 -9
  85. package/docs/Generator/interfaces/ISequentialPickParams.how.md +0 -9
  86. package/docs/Generator/interfaces/ISequentialPickParams.md +0 -79
  87. package/docs/Generator/type-aliases/RandomStepFunction.md +0 -11
  88. package/docs/Generator/type-aliases/SequencePickParams.md +0 -11
  89. package/docs/GeneratorData/Chars/README.md +0 -152
  90. package/docs/GeneratorData/Chars/variables/all.md +0 -9
  91. package/docs/GeneratorData/Chars/variables/alphanumeric.md +0 -9
  92. package/docs/GeneratorData/Chars/variables/base64.md +0 -9
  93. package/docs/GeneratorData/Chars/variables/base64Url.md +0 -9
  94. package/docs/GeneratorData/Chars/variables/base64UrlNoPadding.md +0 -9
  95. package/docs/GeneratorData/Chars/variables/digits.md +0 -9
  96. package/docs/GeneratorData/Chars/variables/hex.md +0 -9
  97. package/docs/GeneratorData/Chars/variables/hexDigits.md +0 -9
  98. package/docs/GeneratorData/Chars/variables/hexDigitsUpper.md +0 -9
  99. package/docs/GeneratorData/Chars/variables/letters.md +0 -9
  100. package/docs/GeneratorData/Chars/variables/lowerCase.md +0 -9
  101. package/docs/GeneratorData/Chars/variables/printable.md +0 -9
  102. package/docs/GeneratorData/Chars/variables/symbols.md +0 -9
  103. package/docs/GeneratorData/Chars/variables/upperCase.md +0 -9
  104. package/docs/GeneratorData/Chars/variables/whitespace.md +0 -9
  105. package/docs/GeneratorData/README.md +0 -35
  106. package/docs/GeneratorData/Words/README.md +0 -125
  107. package/docs/GeneratorData/Words/variables/Adjectives.md +0 -7
  108. package/docs/GeneratorData/Words/variables/Animals.md +0 -7
  109. package/docs/GeneratorData/Words/variables/Cities.md +0 -7
  110. package/docs/GeneratorData/Words/variables/Colors.md +0 -7
  111. package/docs/GeneratorData/Words/variables/Countries.md +0 -7
  112. package/docs/GeneratorData/Words/variables/Domains.md +0 -7
  113. package/docs/GeneratorData/Words/variables/FamilyNames.md +0 -9
  114. package/docs/GeneratorData/Words/variables/FirstNames.md +0 -9
  115. package/docs/GeneratorData/Words/variables/FirstNamesFemale.md +0 -9
  116. package/docs/GeneratorData/Words/variables/FirstNamesMale.md +0 -9
  117. package/docs/GeneratorData/Words/variables/Gerunds.md +0 -7
  118. package/docs/GeneratorData/Words/variables/jobs.md +0 -7
  119. package/docs/GeneratorData/variables/Adjectives.md +0 -7
  120. package/docs/GeneratorData/variables/Animals.md +0 -7
  121. package/docs/GeneratorData/variables/Cities.md +0 -7
  122. package/docs/GeneratorData/variables/Colors.md +0 -7
  123. package/docs/GeneratorData/variables/Countries.md +0 -7
  124. package/docs/GeneratorData/variables/Domains.md +0 -7
  125. package/docs/GeneratorData/variables/FamilyNames.md +0 -9
  126. package/docs/GeneratorData/variables/FirstNames.md +0 -9
  127. package/docs/GeneratorData/variables/FirstNamesFemale.md +0 -9
  128. package/docs/GeneratorData/variables/FirstNamesMale.md +0 -9
  129. package/docs/GeneratorData/variables/Gerunds.md +0 -7
  130. package/docs/GeneratorData/variables/all.md +0 -9
  131. package/docs/GeneratorData/variables/alphanumeric.md +0 -9
  132. package/docs/GeneratorData/variables/base64.md +0 -9
  133. package/docs/GeneratorData/variables/base64Url.md +0 -9
  134. package/docs/GeneratorData/variables/base64UrlNoPadding.md +0 -9
  135. package/docs/GeneratorData/variables/digits.md +0 -9
  136. package/docs/GeneratorData/variables/hex.md +0 -9
  137. package/docs/GeneratorData/variables/hexDigits.md +0 -9
  138. package/docs/GeneratorData/variables/hexDigitsUpper.md +0 -9
  139. package/docs/GeneratorData/variables/jobs.md +0 -7
  140. package/docs/GeneratorData/variables/letters.md +0 -9
  141. package/docs/GeneratorData/variables/lowerCase.md +0 -9
  142. package/docs/GeneratorData/variables/printable.md +0 -9
  143. package/docs/GeneratorData/variables/symbols.md +0 -9
  144. package/docs/GeneratorData/variables/upperCase.md +0 -9
  145. package/docs/GeneratorData/variables/whitespace.md +0 -9
  146. package/docs/README.md +0 -35
  147. package/docs/Words/README.md +0 -125
  148. package/docs/Words/variables/Adjectives.md +0 -7
  149. package/docs/Words/variables/Animals.md +0 -7
  150. package/docs/Words/variables/Cities.md +0 -7
  151. package/docs/Words/variables/Colors.md +0 -7
  152. package/docs/Words/variables/Countries.md +0 -7
  153. package/docs/Words/variables/Domains.md +0 -7
  154. package/docs/Words/variables/FamilyNames.md +0 -9
  155. package/docs/Words/variables/FirstNames.md +0 -9
  156. package/docs/Words/variables/FirstNamesFemale.md +0 -9
  157. package/docs/Words/variables/FirstNamesMale.md +0 -9
  158. package/docs/Words/variables/Gerunds.md +0 -7
  159. package/docs/Words/variables/jobs.md +0 -7
  160. package/docs/classes/PseudoRandomGenerator.clone.md +0 -17
  161. package/docs/classes/PseudoRandomGenerator.create.md +0 -24
  162. package/docs/classes/PseudoRandomGenerator.createChild.md +0 -24
  163. package/docs/classes/PseudoRandomGenerator.ensureRng.md +0 -25
  164. package/docs/classes/PseudoRandomGenerator.getGlobalRng.md +0 -17
  165. package/docs/classes/PseudoRandomGenerator.md +0 -258
  166. package/docs/classes/PseudoRandomGenerator.nextBoolean.md +0 -24
  167. package/docs/classes/PseudoRandomGenerator.nextFloat.md +0 -17
  168. package/docs/classes/PseudoRandomGenerator.nextInRange.md +0 -25
  169. package/docs/classes/PseudoRandomGenerator.nextInt.md +0 -24
  170. package/docs/classes/PseudoRandomGenerator.nextString.md +0 -25
  171. package/docs/classes/PseudoRandomGenerator.pickNext.md +0 -24
  172. package/docs/classes/PseudoRandomGenerator.pickRandom.md +0 -25
  173. package/docs/classes/PseudoRandomGenerator.pickSequence.md +0 -24
  174. package/docs/classes/PseudoRandomGenerator.pickSequential.md +0 -25
  175. package/docs/classes/PseudoRandomGenerator.rng.md +0 -11
  176. package/docs/classes/PseudoRandomGenerator.setGlobalRng.md +0 -24
  177. package/docs/classes/SeededRandomSource.clone.md +0 -17
  178. package/docs/classes/SeededRandomSource.counter.md +0 -11
  179. package/docs/classes/SeededRandomSource.create.md +0 -24
  180. package/docs/classes/SeededRandomSource.createChild.md +0 -24
  181. package/docs/classes/SeededRandomSource.hashSeed.md +0 -24
  182. package/docs/classes/SeededRandomSource.hashStateAndLabel.md +0 -25
  183. package/docs/classes/SeededRandomSource.lineage.md +0 -9
  184. package/docs/classes/SeededRandomSource.md +0 -187
  185. package/docs/classes/SeededRandomSource.mulberryStep.md +0 -24
  186. package/docs/classes/SeededRandomSource.next.md +0 -17
  187. package/docs/classes/SeededRandomSource.seed.md +0 -9
  188. package/docs/interfaces/INextResult.md +0 -61
  189. package/docs/interfaces/INextResult.nextState.md +0 -9
  190. package/docs/interfaces/INextResult.value.md +0 -9
  191. package/docs/interfaces/IPseudoRandomGeneratorCreateParams.global.md +0 -9
  192. package/docs/interfaces/IPseudoRandomGeneratorCreateParams.md +0 -78
  193. package/docs/interfaces/IPseudoRandomGeneratorCreateParams.seed.md +0 -9
  194. package/docs/interfaces/IPseudoRandomGeneratorCreateParams.step.md +0 -9
  195. package/docs/interfaces/IRandomSequencePickParams.candidates.md +0 -9
  196. package/docs/interfaces/IRandomSequencePickParams.count.md +0 -9
  197. package/docs/interfaces/IRandomSequencePickParams.how.md +0 -9
  198. package/docs/interfaces/IRandomSequencePickParams.md +0 -79
  199. package/docs/interfaces/ISeedPair.md +0 -61
  200. package/docs/interfaces/ISeedPair.seed.md +0 -9
  201. package/docs/interfaces/ISeedPair.state.md +0 -9
  202. package/docs/interfaces/ISeededRandomSourceConstructorParams.counter.md +0 -9
  203. package/docs/interfaces/ISeededRandomSourceConstructorParams.lineage.md +0 -9
  204. package/docs/interfaces/ISeededRandomSourceConstructorParams.md +0 -112
  205. package/docs/interfaces/ISeededRandomSourceConstructorParams.seed.md +0 -9
  206. package/docs/interfaces/ISeededRandomSourceConstructorParams.state.md +0 -9
  207. package/docs/interfaces/ISeededRandomSourceConstructorParams.step.md +0 -9
  208. package/docs/interfaces/ISeededRandomSourceCreateParams.md +0 -61
  209. package/docs/interfaces/ISeededRandomSourceCreateParams.seed.md +0 -9
  210. package/docs/interfaces/ISeededRandomSourceCreateParams.step.md +0 -9
  211. package/docs/interfaces/ISequentialPickParams.candidates.md +0 -9
  212. package/docs/interfaces/ISequentialPickParams.count.md +0 -9
  213. package/docs/interfaces/ISequentialPickParams.how.md +0 -9
  214. package/docs/interfaces/ISequentialPickParams.md +0 -79
  215. package/docs/type-aliases/RandomStepFunction.md +0 -11
  216. package/docs/type-aliases/SequencePickParams.md +0 -11
  217. package/docs/variables/Adjectives.md +0 -7
  218. package/docs/variables/Animals.md +0 -7
  219. package/docs/variables/Cities.md +0 -7
  220. package/docs/variables/Colors.md +0 -7
  221. package/docs/variables/Countries.md +0 -7
  222. package/docs/variables/Domains.md +0 -7
  223. package/docs/variables/FamilyNames.md +0 -9
  224. package/docs/variables/FirstNames.md +0 -9
  225. package/docs/variables/FirstNamesFemale.md +0 -9
  226. package/docs/variables/FirstNamesMale.md +0 -9
  227. package/docs/variables/Gerunds.md +0 -7
  228. package/docs/variables/all.md +0 -9
  229. package/docs/variables/alphanumeric.md +0 -9
  230. package/docs/variables/base64.md +0 -9
  231. package/docs/variables/base64Url.md +0 -9
  232. package/docs/variables/base64UrlNoPadding.md +0 -9
  233. package/docs/variables/digits.md +0 -9
  234. package/docs/variables/hex.md +0 -9
  235. package/docs/variables/hexDigits.md +0 -9
  236. package/docs/variables/hexDigitsUpper.md +0 -9
  237. package/docs/variables/jobs.md +0 -7
  238. package/docs/variables/letters.md +0 -9
  239. package/docs/variables/lowerCase.md +0 -9
  240. package/docs/variables/printable.md +0 -9
  241. package/docs/variables/symbols.md +0 -9
  242. package/docs/variables/upperCase.md +0 -9
  243. package/docs/variables/whitespace.md +0 -9
  244. package/lib/test/unit/generators.test.d.ts +0 -2
  245. package/lib/test/unit/generators.test.d.ts.map +0 -1
  246. package/lib/test/unit/generators.test.js +0 -598
  247. package/lib/test/unit/generators.test.js.map +0 -1
  248. package/lib/test/unit/randomSource.test.d.ts +0 -2
  249. package/lib/test/unit/randomSource.test.d.ts.map +0 -1
  250. package/lib/test/unit/randomSource.test.js +0 -454
  251. package/lib/test/unit/randomSource.test.js.map +0 -1
  252. package/rush-logs/ts-random.build.cache.log +0 -3
  253. package/rush-logs/ts-random.build.log +0 -6
  254. package/src/generator/generators.ts +0 -273
  255. package/src/generator/index.ts +0 -22
  256. package/src/generator/randomSource.ts +0 -224
  257. package/src/generator-data/charClasses.ts +0 -95
  258. package/src/generator-data/index.ts +0 -22
  259. package/src/generator-data/words/adjectives.ts +0 -247
  260. package/src/generator-data/words/animals.ts +0 -75
  261. package/src/generator-data/words/cities.ts +0 -229
  262. package/src/generator-data/words/colors.ts +0 -56
  263. package/src/generator-data/words/countries.ts +0 -217
  264. package/src/generator-data/words/domains.ts +0 -47
  265. package/src/generator-data/words/gerunds.ts +0 -126
  266. package/src/generator-data/words/index.ts +0 -29
  267. package/src/generator-data/words/jobs.ts +0 -175
  268. package/src/generator-data/words/names.ts +0 -717
  269. package/src/index.ts +0 -7
  270. package/src/test/unit/generators.test.ts +0 -697
  271. package/src/test/unit/randomSource.test.ts +0 -526
  272. package/temp/build/typescript/ts_8nwakTlr.json +0 -1
  273. package/tsconfig.json +0 -7
package/docs/interfaces/IPseudoRandomGeneratorCreateParams.md DELETED
@@ -1,78 +0,0 @@
1
- [Home](../README.md) > IPseudoRandomGeneratorCreateParams
2
-
3
- # Interface: IPseudoRandomGeneratorCreateParams
4
-
5
- Parameters for creating a generator.
6
-
7
- ## Properties
8
-
9
- <table><thead><tr><th>
10
-
11
- Property
12
-
13
- </th><th>
14
-
15
- Modifiers
16
-
17
- </th><th>
18
-
19
- Type
20
-
21
- </th><th>
22
-
23
- Description
24
-
25
- </th></tr></thead>
26
- <tbody>
27
- <tr><td>
28
-
29
- [seed](./IPseudoRandomGeneratorCreateParams.seed.md)
30
-
31
- </td><td>
32
-
33
-
34
-
35
- </td><td>
36
-
37
- string | number
38
-
39
- </td><td>
40
-
41
-
42
-
43
- </td></tr>
44
- <tr><td>
45
-
46
- [step](./IPseudoRandomGeneratorCreateParams.step.md)
47
-
48
- </td><td>
49
-
50
-
51
-
52
- </td><td>
53
-
54
- [RandomStepFunction](../type-aliases/RandomStepFunction.md)
55
-
56
- </td><td>
57
-
58
-
59
-
60
- </td></tr>
61
- <tr><td>
62
-
63
- [global](./IPseudoRandomGeneratorCreateParams.global.md)
64
-
65
- </td><td>
66
-
67
-
68
-
69
- </td><td>
70
-
71
- boolean
72
-
73
- </td><td>
74
-
75
-
76
-
77
- </td></tr>
78
- </tbody></table>
package/docs/interfaces/IPseudoRandomGeneratorCreateParams.seed.md DELETED
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [IPseudoRandomGeneratorCreateParams](./IPseudoRandomGeneratorCreateParams.md) > seed
2
-
3
- ## IPseudoRandomGeneratorCreateParams.seed property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- seed: string | number;
9
- ```
package/docs/interfaces/IPseudoRandomGeneratorCreateParams.step.md DELETED
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [IPseudoRandomGeneratorCreateParams](./IPseudoRandomGeneratorCreateParams.md) > step
2
-
3
- ## IPseudoRandomGeneratorCreateParams.step property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- step: RandomStepFunction;
9
- ```
package/docs/interfaces/IRandomSequencePickParams.candidates.md DELETED
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [IRandomSequencePickParams](./IRandomSequencePickParams.md) > candidates
2
-
3
- ## IRandomSequencePickParams.candidates property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- candidates: readonly (readonly T[])[];
9
- ```
package/docs/interfaces/IRandomSequencePickParams.count.md DELETED
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [IRandomSequencePickParams](./IRandomSequencePickParams.md) > count
2
-
3
- ## IRandomSequencePickParams.count property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- count: number;
9
- ```
package/docs/interfaces/IRandomSequencePickParams.how.md DELETED
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [IRandomSequencePickParams](./IRandomSequencePickParams.md) > how
2
-
3
- ## IRandomSequencePickParams.how property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- how: "random";
9
- ```
package/docs/interfaces/IRandomSequencePickParams.md DELETED
@@ -1,79 +0,0 @@
1
- [Home](../README.md) > IRandomSequencePickParams
2
-
3
- # Interface: IRandomSequencePickParams
4
-
5
- Parameters for generating a sequence of values
6
- by randomly selecting from dictionaries in a supplied set.
7
-
8
- ## Properties
9
-
10
- <table><thead><tr><th>
11
-
12
- Property
13
-
14
- </th><th>
15
-
16
- Modifiers
17
-
18
- </th><th>
19
-
20
- Type
21
-
22
- </th><th>
23
-
24
- Description
25
-
26
- </th></tr></thead>
27
- <tbody>
28
- <tr><td>
29
-
30
- [how](./IRandomSequencePickParams.how.md)
31
-
32
- </td><td>
33
-
34
-
35
-
36
- </td><td>
37
-
38
- "random"
39
-
40
- </td><td>
41
-
42
-
43
-
44
- </td></tr>
45
- <tr><td>
46
-
47
- [count](./IRandomSequencePickParams.count.md)
48
-
49
- </td><td>
50
-
51
-
52
-
53
- </td><td>
54
-
55
- number
56
-
57
- </td><td>
58
-
59
-
60
-
61
- </td></tr>
62
- <tr><td>
63
-
64
- [candidates](./IRandomSequencePickParams.candidates.md)
65
-
66
- </td><td>
67
-
68
-
69
-
70
- </td><td>
71
-
72
- readonly (readonly T[])[]
73
-
74
- </td><td>
75
-
76
-
77
-
78
- </td></tr>
79
- </tbody></table>
package/docs/interfaces/ISeedPair.md DELETED
@@ -1,61 +0,0 @@
1
- [Home](../README.md) > ISeedPair
2
-
3
- # Interface: ISeedPair
4
-
5
- Represents a seed as both a string and a number.
6
-
7
- ## Properties
8
-
9
- <table><thead><tr><th>
10
-
11
- Property
12
-
13
- </th><th>
14
-
15
- Modifiers
16
-
17
- </th><th>
18
-
19
- Type
20
-
21
- </th><th>
22
-
23
- Description
24
-
25
- </th></tr></thead>
26
- <tbody>
27
- <tr><td>
28
-
29
- [seed](./ISeedPair.seed.md)
30
-
31
- </td><td>
32
-
33
-
34
-
35
- </td><td>
36
-
37
- string
38
-
39
- </td><td>
40
-
41
-
42
-
43
- </td></tr>
44
- <tr><td>
45
-
46
- [state](./ISeedPair.state.md)
47
-
48
- </td><td>
49
-
50
-
51
-
52
- </td><td>
53
-
54
- number
55
-
56
- </td><td>
57
-
58
-
59
-
60
- </td></tr>
61
- </tbody></table>
package/docs/interfaces/ISeedPair.seed.md DELETED
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [ISeedPair](./ISeedPair.md) > seed
2
-
3
- ## ISeedPair.seed property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- seed: string;
9
- ```
package/docs/interfaces/ISeedPair.state.md DELETED
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [ISeedPair](./ISeedPair.md) > state
2
-
3
- ## ISeedPair.state property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- state: number;
9
- ```
package/docs/interfaces/ISeededRandomSourceConstructorParams.counter.md DELETED
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [ISeededRandomSourceConstructorParams](./ISeededRandomSourceConstructorParams.md) > counter
2
-
3
- ## ISeededRandomSourceConstructorParams.counter property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- counter: number;
9
- ```
package/docs/interfaces/ISeededRandomSourceConstructorParams.lineage.md DELETED
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [ISeededRandomSourceConstructorParams](./ISeededRandomSourceConstructorParams.md) > lineage
2
-
3
- ## ISeededRandomSourceConstructorParams.lineage property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- lineage: readonly string[];
9
- ```
package/docs/interfaces/ISeededRandomSourceConstructorParams.md DELETED
@@ -1,112 +0,0 @@
1
- [Home](../README.md) > ISeededRandomSourceConstructorParams
2
-
3
- # Interface: ISeededRandomSourceConstructorParams
4
-
5
- Constructor params for a Generator.SeededRandomSource | SeededRandomSource.
6
-
7
- ## Properties
8
-
9
- <table><thead><tr><th>
10
-
11
- Property
12
-
13
- </th><th>
14
-
15
- Modifiers
16
-
17
- </th><th>
18
-
19
- Type
20
-
21
- </th><th>
22
-
23
- Description
24
-
25
- </th></tr></thead>
26
- <tbody>
27
- <tr><td>
28
-
29
- [state](./ISeededRandomSourceConstructorParams.state.md)
30
-
31
- </td><td>
32
-
33
-
34
-
35
- </td><td>
36
-
37
- number
38
-
39
- </td><td>
40
-
41
-
42
-
43
- </td></tr>
44
- <tr><td>
45
-
46
- [seed](./ISeededRandomSourceConstructorParams.seed.md)
47
-
48
- </td><td>
49
-
50
-
51
-
52
- </td><td>
53
-
54
- string
55
-
56
- </td><td>
57
-
58
-
59
-
60
- </td></tr>
61
- <tr><td>
62
-
63
- [counter](./ISeededRandomSourceConstructorParams.counter.md)
64
-
65
- </td><td>
66
-
67
-
68
-
69
- </td><td>
70
-
71
- number
72
-
73
- </td><td>
74
-
75
-
76
-
77
- </td></tr>
78
- <tr><td>
79
-
80
- [lineage](./ISeededRandomSourceConstructorParams.lineage.md)
81
-
82
- </td><td>
83
-
84
-
85
-
86
- </td><td>
87
-
88
- readonly string[]
89
-
90
- </td><td>
91
-
92
-
93
-
94
- </td></tr>
95
- <tr><td>
96
-
97
- [step](./ISeededRandomSourceConstructorParams.step.md)
98
-
99
- </td><td>
100
-
101
-
102
-
103
- </td><td>
104
-
105
- [RandomStepFunction](../type-aliases/RandomStepFunction.md)
106
-
107
- </td><td>
108
-
109
-
110
-
111
- </td></tr>
112
- </tbody></table>
package/docs/interfaces/ISeededRandomSourceConstructorParams.seed.md DELETED
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [ISeededRandomSourceConstructorParams](./ISeededRandomSourceConstructorParams.md) > seed
2
-
3
- ## ISeededRandomSourceConstructorParams.seed property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- seed: string;
9
- ```
package/docs/interfaces/ISeededRandomSourceConstructorParams.state.md DELETED
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [ISeededRandomSourceConstructorParams](./ISeededRandomSourceConstructorParams.md) > state
2
-
3
- ## ISeededRandomSourceConstructorParams.state property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- state: number;
9
- ```
package/docs/interfaces/ISeededRandomSourceConstructorParams.step.md DELETED
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [ISeededRandomSourceConstructorParams](./ISeededRandomSourceConstructorParams.md) > step
2
-
3
- ## ISeededRandomSourceConstructorParams.step property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- step: RandomStepFunction;
9
- ```
package/docs/interfaces/ISeededRandomSourceCreateParams.md DELETED
@@ -1,61 +0,0 @@
1
- [Home](../README.md) > ISeededRandomSourceCreateParams
2
-
3
- # Interface: ISeededRandomSourceCreateParams
4
-
5
- Static create parameters for a Generator.SeededRandomSource | SeededRandomSource.
6
-
7
- ## Properties
8
-
9
- <table><thead><tr><th>
10
-
11
- Property
12
-
13
- </th><th>
14
-
15
- Modifiers
16
-
17
- </th><th>
18
-
19
- Type
20
-
21
- </th><th>
22
-
23
- Description
24
-
25
- </th></tr></thead>
26
- <tbody>
27
- <tr><td>
28
-
29
- [seed](./ISeededRandomSourceCreateParams.seed.md)
30
-
31
- </td><td>
32
-
33
-
34
-
35
- </td><td>
36
-
37
- string | number
38
-
39
- </td><td>
40
-
41
-
42
-
43
- </td></tr>
44
- <tr><td>
45
-
46
- [step](./ISeededRandomSourceCreateParams.step.md)
47
-
48
- </td><td>
49
-
50
-
51
-
52
- </td><td>
53
-
54
- [RandomStepFunction](../type-aliases/RandomStepFunction.md)
55
-
56
- </td><td>
57
-
58
-
59
-
60
- </td></tr>
61
- </tbody></table>
package/docs/interfaces/ISeededRandomSourceCreateParams.seed.md DELETED
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [ISeededRandomSourceCreateParams](./ISeededRandomSourceCreateParams.md) > seed
2
-
3
- ## ISeededRandomSourceCreateParams.seed property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- seed: string | number;
9
- ```
package/docs/interfaces/ISeededRandomSourceCreateParams.step.md DELETED
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [ISeededRandomSourceCreateParams](./ISeededRandomSourceCreateParams.md) > step
2
-
3
- ## ISeededRandomSourceCreateParams.step property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- step: RandomStepFunction;
9
- ```
package/docs/interfaces/ISequentialPickParams.candidates.md DELETED
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [ISequentialPickParams](./ISequentialPickParams.md) > candidates
2
-
3
- ## ISequentialPickParams.candidates property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- candidates: readonly (readonly T[])[];
9
- ```
package/docs/interfaces/ISequentialPickParams.count.md DELETED
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [ISequentialPickParams](./ISequentialPickParams.md) > count
2
-
3
- ## ISequentialPickParams.count property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- count: number;
9
- ```
package/docs/interfaces/ISequentialPickParams.how.md DELETED
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [ISequentialPickParams](./ISequentialPickParams.md) > how
2
-
3
- ## ISequentialPickParams.how property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- how: "sequence";
9
- ```
package/docs/interfaces/ISequentialPickParams.md DELETED
@@ -1,79 +0,0 @@
1
- [Home](../README.md) > ISequentialPickParams
2
-
3
- # Interface: ISequentialPickParams
4
-
5
- Parameters for generating a sequence of values
6
- from each dictionary in a supplied set, in turn.
7
-
8
- ## Properties
9
-
10
- <table><thead><tr><th>
11
-
12
- Property
13
-
14
- </th><th>
15
-
16
- Modifiers
17
-
18
- </th><th>
19
-
20
- Type
21
-
22
- </th><th>
23
-
24
- Description
25
-
26
- </th></tr></thead>
27
- <tbody>
28
- <tr><td>
29
-
30
- [how](./ISequentialPickParams.how.md)
31
-
32
- </td><td>
33
-
34
-
35
-
36
- </td><td>
37
-
38
- "sequence"
39
-
40
- </td><td>
41
-
42
-
43
-
44
- </td></tr>
45
- <tr><td>
46
-
47
- [count](./ISequentialPickParams.count.md)
48
-
49
- </td><td>
50
-
51
-
52
-
53
- </td><td>
54
-
55
- number
56
-
57
- </td><td>
58
-
59
-
60
-
61
- </td></tr>
62
- <tr><td>
63
-
64
- [candidates](./ISequentialPickParams.candidates.md)
65
-
66
- </td><td>
67
-
68
-
69
-
70
- </td><td>
71
-
72
- readonly (readonly T[])[]
73
-
74
- </td><td>
75
-
76
-
77
-
78
- </td></tr>
79
- </tbody></table>
package/docs/type-aliases/RandomStepFunction.md DELETED
@@ -1,11 +0,0 @@
1
- [Home](../README.md) > RandomStepFunction
2
-
3
- # Type Alias: RandomStepFunction
4
-
5
- Function that steps a random number generator state and returns the next value.
6
-
7
- ## Type
8
-
9
- ```typescript
10
- type RandomStepFunction = (state: number) => INextResult
11
- ```
package/docs/type-aliases/SequencePickParams.md DELETED
@@ -1,11 +0,0 @@
1
- [Home](../README.md) > SequencePickParams
2
-
3
- # Type Alias: SequencePickParams
4
-
5
- Type representing parameters for generating a sequence of values.
6
-
7
- ## Type
8
-
9
- ```typescript
10
- type SequencePickParams = ISequentialPickParams<T> | IRandomSequencePickParams<T>
11
- ```
package/docs/variables/Adjectives.md DELETED
@@ -1,7 +0,0 @@
1
- [Home](../README.md) > Adjectives
2
-
3
- # Variable: Adjectives
4
-
5
- ## Type
6
-
7
- `ReadonlyArray<string>`
package/docs/variables/Animals.md DELETED
@@ -1,7 +0,0 @@
1
- [Home](../README.md) > Animals
2
-
3
- # Variable: Animals
4
-
5
- ## Type
6
-
7
- `ReadonlyArray<string>`