fake-data-builder

Makes it easy to build and manage large generated datasets.

``
npm i -D fake-data-builder
`

Usage

`javascript
import { build, sequence, randWord } from 'fake-data-builder';

const buildUser = build({
id: sequence(),
name: randWord({ multiply: 2, capitalize: true }),
job: randWord({ multiply: 3, capitalize: true })
});

const user: User = buildUser({
name: 'Harry Hands'
});

// user ~= {
// id: 1,
// name: 'Harry Hands',
// job: 'Ancient Usually Putting'
// }
`

This dataset can be deeply nested, all functions that are passed as values will be run. What follows are a set of generators and helpers that are included.

Generators

$3

Generate a random integer. Can be given min max values, the defaults are 1 10.

`javascript
randInt({ min: 0, max: 5 })();
`

Integer between 0 and 5 (inclusive).

$3

Generate a random float. Can be given min max values, the defaults are 0 1.

`javascript
randFloat({ min: 11, max: 22.5 })();
`

Float between 11 and 22.5 (inclusive).

$3

Generate either true or false. Can be given a median value, this determines the likelihood of being true.

`javascript
randBoolean({ median: 0.6 })();
`

Will be true 60% of the time.

$3

Generate a random Date object. Can be given timeAgo fromNow values in ms, the defaults are 31557600000 * 2 (2 years) 0.

`javascript
randDate({ timeAgo: 0, fromNow: 900000 })();
`

Date object between now and 15 minutes from now.

$3

Generate a random string. Can be given charset length values, the defaults are 'ln' (lowercase and numbers) 5. Charset can include 'u' to add uppercase and 's' for special characters. Can be given a chars value, the default is '' these are added to the charset. Can be given prefix postfix values, the defaults are '' ''.

`javascript
randString({ charset: '', chars: 'abcde', length: 6 })();
`

String containing only 'abcde' characters 6 characters long.

$3

Generate a random string from a word list. Can be given capitalize uppercase, the defaults are false false. Can be given multiply separator, the defaults are 1 ' ' these are how many words to generate and how to separate them. Can be given prefix postfix values, the defaults are '' ''.

`javascript
randWord({ capitalize: true })();
`

^{Capitalized word}

$3

Generate a random string made up of many sentences. Can be given sentencesMin sentencesMax, the defaults are 5 20 these are the number of sentences per paragraph. Can be given wordsMin wordsMax, the defaults are 5 20 these are the number of words per sentence. Can be given multiply separator, the defaults are 1 '\n\n' these are how many paragraphs to generate and how to separate them.

`javascript
randParagraph({ sentencesMin: 2, sentencesMax: 50, multiply: 2 })();
`

^{Two paragraphs of highly variable length.}

$3

Returns either null or the provided value.

`javascript
nullable(randInt(), 0.6)();
`

^{Will be an integer 60% of the time.}

Helpers

$3

Returns a number that is guaranteed to be unique, accepts a generator as a parameter for more control.

`javascript
const result = sequence(i => user-${i})();

// result ~= 'user-1'
`

$3

Returns one of the provided parameters at random.

`javascript
const result = oneOf('Larry', 'Curly', 'Moe')();

// result ~= 'Curly'
`

$3

Returns an array of the provided value a given number of times.

`javascript
const rgb = randString({ charset: 'n', chars: 'ABCDEF', prefix: '#' });
const result = arrayOf(rgb, 4)();

// result ~= ['#1ECBE1', '#961EE1', '#E1341E', '#6AE11E']
`

Considerations

A builder can be provided as the value for another builder.

`javascript
const buildAddress = build