dataset-generator

Motivation

This is simple data mock generator which generate random combination of values according provided object shape.

1. Has strong TypeScript support (created objects have inferred type from provided data).
2. Bundle has zero dependencies.
3. Can be used with you own data or other solutions.
4. Supports computed values and references to other keys.

How to install

npm i dataset-generator

How to use

1. Simple example:

import { create } from 'mock-data-generator';

// It will create produce function with pre-defined shape
// Base shape format - key = string, value = array of posible values
const produce = create({
  // output will have one on provided values
  name: ['John', 'Mary', 'Amy'],
  jobTitle: ['developer', 'QA'],
});

// It will create 10 users with provided shape
// e.g. {name: string; jobTitle: string}[]
const dataset = produce(10);

2. With defined types.

import { create, DEFINED } from 'mock-data-generator';

const produce = create({
  // it will create incremental id
  id: DEFINED.ID,
  // it will create date timestamp
  now: DEFINED.DATE_NOW,
  // create random integer
  quantity: DEFINED.INTEGER,
  // create random float
  price: DEFINED.FLOAT,
  // create random boolean
  isAvailable: DEFINED.BOOLEAN,
});

// {id: number, now: number; quantity: number, price: number, isAvailable: boolean }[]
const dataset = produce(10);

3. With function as a value.

import { create, DEFINED } from 'mock-data-generator';

const produce = create({
  id: DEFINED.ID,
  now: () => Date.now(),
  greeting: () => 'Hello',
});

// {id: number, now: number; greeting: 'Hello'}[]
const dataset = produce(10);

4. With nested objects.

import { create, DEFINED } from 'mock-data-generator';

const produce = create({
  id: DEFINED.ID,
  name: {
    first: ['John', 'Mary', 'Andy'],
    last: ['Smith', 'King'],
  },
});

// {id: number, name: {first: string, last: string}}[]
const dataset = produce(10);

5. With reference.

import { create, DEFINED } from 'mock-data-generator';

const dataset = create({
  id: DEFINED.ID,
  name: ['John', 'Paul', 'Joe'],
  // it will create string like 'Hello John'
  greeting: ['Hello {name}'],
  address: {
    street: ['Don', 'Ave'],
    number: [12, 20],
    // Nested object supported
    line: ['{address.street} {address.number}'],
  },
})(10);

const users = create({
  id: DEFINED.ID,
  // key order doesn't matter - all refrences will be resolved after main processing
  // So output will have actual name in the greeting text
  greeting: ['Hello {name}'],
  name: ['John', 'Paul', 'Joe'],
})(10);