0.3.0 • Published 9 months ago

@faissaloux/fake-data v0.3.0

Weekly downloads
-
License
MIT
Repository
-
Last release
9 months ago

fake-data

Stimulates your API response to make it easy to test your frontend without (before) using your real one.

Tests codecov npm version NPM Downloads GitHub license

Installation

    npm install @faissaloux/fake-data

or

    yarn add @faissaloux/fake-data

Usage

To generate an array of fake data objects you can use useFakeData.

import { useFakeData } from '@faissaloux/fake-data';

const popularTrips = useFakeData({
    driver: 'person.firstName',
    from: 'location.city',
    to: 'location.city'
});
// popularTrips

[
    {
        driver: "Krystal",
        from: "New York",
        to: "Connport"
    }
]

You can even specify how much data you want, by passing the count as the 2nd argument.

import { useFakeData } from '@faissaloux/fake-data';

const popularTrips = useFakeData({
    from: 'location.city',
    to: 'location.city',
    driver: {
        'first_name': 'person.firstName'
    }
}, 2);
// popularTrips

[
    {
        driver: {
            first_name: "Walker",
        },
        from: "Archibaldburgh",
        to: "Port Dashawnport"
    },
    {
        driver: {
            first_name: "Mercedes",
        },
        from: "Port Charlotte",
        to: "West Myles"
    }
]

Use args to customize your data

You can customize your data by using args.

import { useFakeData } from '@faissaloux/fake-data';

const popularTrips = useFakeData({
    from: 'location.city',
    to: 'location.city',
    driver: {
        first_name: 'person.firstName',
        price: {
            identifier: 'finance.amount',
            args: {min: 0, max: 100, asNumber: true}
        },
    }
});
// popularTrips

[
    {
        driver: {
            first_name: "Michael",
            price: 66.51
        },
        from: "Helmerbury",
        to: "New Minniestead"
    }
]

Supported data

IdentifierReturn typeArgs typeOptions
location.citystringNo paramsNo params
location.countrystringNo paramsNo params
person.firstNamestring'male'|'female''male' or 'female'
person.lastNamestring'male'|'female''male' or 'female'
finance.amountstring|numberobjectmin?: number
max?: number
dec?: number
symbol: string
asNumber?: boolean
finance.currencyCodestringNo paramsNo params
finance.currencySymbolstringNo paramsNo params
image.avatarstringNo paramsNo params
0.3.0

9 months ago

0.2.0

9 months ago

0.1.0

9 months ago