0.3.0 • Published 9 months ago
@faissaloux/fake-data v0.3.0
fake-data
Stimulates your API response to make it easy to test your frontend without (before) using your real one.
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
Identifier | Return type | Args type | Options |
---|---|---|---|
location.city | string | No params | No params |
location.country | string | No params | No params |
person.firstName | string | 'male'|'female' | 'male' or 'female' |
person.lastName | string | 'male'|'female' | 'male' or 'female' |
finance.amount | string|number | object | min?: number |
max?: number | |||
dec?: number | |||
symbol: string | |||
asNumber?: boolean | |||
finance.currencyCode | string | No params | No params |
finance.currencySymbol | string | No params | No params |
image.avatar | string | No params | No params |