Never Pay your Mortgage

    maslo

    0.0.2 • Public • Published

    Maslo

    NPM version Travis Build Status Coverage Status XO code style

    Simple JSON fake data creation.

    Installation

    $ npm install maslo --save-dev

    Probably you will want to use faker.js.

    $ npm install faker --save-dev

    or chancejs.

    $ npm install chance --save-dev

    Usage

    All examples uses faker.js.

    ES6

    import faker from 'faker';
    import {
        shape,
        bool,
        oneOf,
        arrayOf,
        optional
    } from 'maslo';
     
    const fakeUserSchema = shape({
        id: faker.random.uuid,
        name: faker.name.findName,
        description: optional(() => 'description'),
        isAdmin: bool(),
        status: oneOf(['slave', 'master']),
        posts: arrayOf(shape({
            id: faker.random.uuid,
            title: faker.name.findName
        }), 1, 5)
    });
     
    const fakeUserJSON = fakeUserSchema();
     

    Api

    shape(Object)

    Returns a function, which iterates on a provided object's keys and calls them (in case of the key is a function) or just returns it's value.

    bool()

    Returns a function, which returns true or false.

    arrayOf(Array, [min, max])

    Returns a function, which iterates on a provided array's values and calls them (in case of the value is a function) or just returns it's value.

    min Type: Number

    Min length of generated array. Default: 5;

    max Type: Number

    Max length of generated array.

    oneOf(Array)

    Returns a function, which returns one of provided array value.

    optional(Function)

    Returns a function, which returns function's result or special @@OPTIONAL value. Shape will remove all @@OPTIONAL values from himself.

    License

    MIT © Aleksandr Yakunichev

    Install

    npm i maslo

    DownloadsWeekly Downloads

    6

    Version

    0.0.2

    License

    MIT

    Last publish

    Collaborators

    • canvaskisa