toosoon-prng 1.0.1 → 1.0.2

package/README.md

@@ -138,38 +138,70 @@ prng.randomIndex(seed: string, weights?: number[]) => number;
 
 ## PRNG Controllers
 
-`BooleanController`
+```ts
+class BooleanController(seed: string, probability?: number);
+```
 
-`SignController`
+```ts
+class SignController(seed: string, probability?: number);
+```
 
-`FloatController`
+```ts
+class FloatController(seed: string, min?: number, max?: number);
+```
 
-`IntController`
+```ts
+class IntController(seed: string, min: number, max: number);
+```
 
-`HexColorController`
+```ts
+class HexColorController(seed: string);
+```
 
-`ItemController`
+```ts
+class ItemController<T>(seed: string, items: T[]);
+```
 
-`ObjectPropertyController`
+```ts
+class ObjectPropertyController<T>(seed: string, object: object);
+```
 
-`WeightsController`
+```ts
+class WeightsController<T>(seed: string, items: Array<{ weight: number; value: T }>);
+```
 
-`BooleanGroupController`
+```ts
+class BooleanGroupController(seed: string, probability: number);
+```
 
-`SignGroupController`
+```ts
+class SignGroupController(seed: string, probability: number);
+```
 
-`FloatGroupController`
+```ts
+class FloatGroupController(seed: string, min: number, max: number);
+```
 
-`IntGroupController`
+```ts
+class IntGroupController(seed: string, min: number, max: number);
+```
 
-`HexColorGroupController`
+```ts
+class HexColorGroupController(seed: string);
+```
 
-`ItemGroupController`
+```ts
+class ItemGroupController<T>(seed: string, items: T[]);
+```
 
-`ObjectPropertyGroupController`
+```ts
+class ObjectPropertyGroupController<T>(seed: string, object: object);
+```
 
-`WeightsGroupController`
+```ts
+class WeightsGroupController<T>(seed: string, items: Array<{ weight: number; value: T }>);
+```
 
 ## License
 
-MIT License, see [LICENSE](https://github.com/toosoon-dev/toosoon-lsystem/tree/master/LICENSE) for details
+MIT License, see [LICENSE](https://github.com/toosoon-dev/toosoon-prng/tree/master/LICENSE) for details

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "toosoon-prng",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Pseudo-random number generator utility functions & helpers",
   "main": "./lib/index.js",
   "scripts": {

package/src/controllers.ts

@@ -102,7 +102,7 @@ export class BooleanController extends BasePRNGController<boolean> {
   value: boolean;
   probability: number;
 
-  constructor(seed: string, probability = 0.5) {
+  constructor(seed: string, probability: number = 0.5) {
     super(seed);
 
     this.probability = probability;
@@ -125,7 +125,7 @@ export class SignController extends BasePRNGController<number> {
   value: number;
   probability: number;
 
-  constructor(seed: string, probability = 0.5) {
+  constructor(seed: string, probability: number = 0.5) {
     super(seed);
 
     this.probability = probability;
@@ -149,7 +149,7 @@ export class FloatController extends BasePRNGController<number> {
   min: number;
   max: number;
 
-  constructor(seed: string, min = 0, max = 1) {
+  constructor(seed: string, min: number = 0, max: number = 1) {
     super(seed);
 
     this.min = min;
@@ -174,7 +174,7 @@ export class IntController extends BasePRNGController<number> {
   min: number;
   max: number;
 
-  constructor(seed: string, min = 0, max = 1) {
+  constructor(seed: string, min: number, max: number) {
     super(seed);
 
     this.min = min;
@@ -240,9 +240,9 @@ export class ItemController<T = unknown> extends BasePRNGController<T> {
 
 export class ObjectPropertyController<T = unknown> extends BasePRNGController<T> {
   value: T;
-  object: Object;
+  object: { [key: string]: T };
 
-  constructor(seed: string, object: Object) {
+  constructor(seed: string, object: { [key: string]: T }) {
     super(seed);
 
     this.object = object;
@@ -255,7 +255,7 @@ export class ObjectPropertyController<T = unknown> extends BasePRNGController<T>
   }
 
   getValue() {
-    this.value = prng.randomObjectProperty(this.seed, this.object) as T;
+    this.value = prng.randomObjectProperty<T>(this.seed, this.object) as T;
     this.gui?.updateDisplay();
     return this.value;
   }
@@ -390,10 +390,10 @@ export class ItemGroupController<T = unknown> extends BasePRNGGroupController<T>
 }
 
 export class ObjectPropertyGroupController<T = unknown> extends BasePRNGGroupController<T> {
-  object: Object;
+  object: { [key: string]: T };
   controllers: ObjectPropertyController<T>[] = [];
 
-  constructor(seed: string, object: Object) {
+  constructor(seed: string, object: { [key: string]: T }) {
     super(seed);
 
     this.object = object;

package/src/prng.ts

@@ -75,7 +75,7 @@ class PRNG {
     return array[this.randomInt(seed, 0, array.length - 1)];
   }
 
-  public randomObjectProperty(seed: string, object: object): unknown | undefined {
+  public randomObjectProperty<T = unknown>(seed: string, object: { [key: string]: T }): T | undefined {
     const keys = Object.keys(object);
     const key = this.randomItem(seed, keys);
     if (key && object.hasOwnProperty(key)) {