raiondesu / js-random

A collection of simple and lightweight randomizers for JavaScript (TypeScript friendly)

js-random

A collection of simple and lightweight randomizers for JavaScript (TypeScript friendly)

Packages

• @js-random/all - all other packages in one - GitHub repo, NPM
• @js-random/number GitHub repo, NPM
• @js-random/string GitHub repo, NPM
• @js-random/boolean GitHub repo, NPM
• @js-random/date GitHub repo, NPM

Installation and usage

See links above.

js-random's Issues

Add `@js-random/array`

declare function randomArray(length?: number, seed?: any[]): any[];

Add `@js-random/string`

declare function randomString(length?: number, seed?: string, filter?: RegExp): string;
declare function randomString(options: {
  length?: number,
  seed?: string,
  filter?: RegExp
}): string;

Add tests for packages

Added tests for:

• number
• string
• date
• boolean
• function
• object
• array

---

There are __tests__ folders in each package's directories. These are prepared to run tests. All the dependencies are ready and installed. Only tests themselves are absent...

Add `@js-random/html-element`

declare function randomHtmlElement(options?: {
  attributes?: { [name: string]: string; },
  classes: string[],
  seed?: HTMLElement[] | Array<typeof HTMLElement>
}): HTMLElement;

Make versions with side effects

Add versions of packages that assign themselves as random() functions to the constructor of a respective type, like Constructor.random()

For example:

Number.random();
String.random();
Boolean.random();
Object.random();
...

Usage would then be (for number, for example):

import '@js-random/number/integrate';
//or
require('@js-random/number/integrate');

// and then

Number.random(0, 10); // random number from 0 to 10

Add `@js-random/object`

declare function randomObject(options?: {
  seed?: object,
  valueTypes?: string[] | Array<String | Object | Function | Array | Object>,
  depth?: number,
  keysAmount?: number | {
    from: number,
    to: number
  }
})

Add `@js-random/function`

declare function randomFunction(options?: {
  seed?: Array<Function> | object;
  throwErrors?: boolean;
}): Function;

Add `@js-random/date`

declare function randomDate(range?: { from: Date, to: Date }): Date;

Add `@js-random/cat`

// Returns a URL to a random cat (´・ω・`)
declare function randomCat(type: 'gif' | 'image' | 'video'): string;

Add `@js-random/stuff`

declare function random(): any;

Add `@js-random/big-int`

declare function randomBigInt(min?: number | BigInt, max?: number | BigInt): BigInt;