fake-data

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

   !NPM Downloads 

Installation

``bash
npm install @faissaloux/fake-data
`
or
`bash
yarn add @faissaloux/fake-data
`

Usage

To generate an array of fake data objects you can use useFakeData.
`js
import { useFakeData } from '@faissaloux/fake-data';

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

`js
// 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.
`js
import { useFakeData } from '@faissaloux/fake-data';

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

`js
// popularTrips

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

$3


You can customize your data by using args.

`js
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}
},
}
});
`

`js
// popularTrips

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

Supported data

Data type	Identifier	Return type	Args type	Options
location	location.city	string	[No params]	[No params]
	location.country	string	[No params]	[No params]
	location.zipCode	string	string|object	string or { format?: string }
person	person.firstName	string	'male'\|'female'	'male' or 'female'
	person.middleName	string	'male'\|'female'	'male' or 'female'
	person.lastName	string	'male'\|'female'	'male' or 'female'
	person.fullName	string	object	{ firstName?: string, lastName?: string, sex?: 'male' | 'female' }
	person.prefix	string	'male'\|'female'	'male' or 'female'
	person.suffix	string	[No params]	[No params]
	person.jobArea	string	[No params]	[No params]
	person.jobTitle	string	[No params]	[No params]
	person.jobType	string	[No params]	[No params]
	person.jobDescriptor	string	[No params]	[No params]
	person.sex	string	[No params]	[No params]
finance	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]
commerce	commerce.product	string	[No params]	[No params]
image	image.avatar	string	[No params]	[No params]
system	system.mimeType	string	[No params]	[No params]
	system.semver	string	[No params]	[No params]
phone	phone.imei	string	[No params]	[No params]
	phone.number	string	[No params]	[No params]
internet	internet.email	string	object	{ firstName?: string, lastName?: string, provider?: string }
lorem	lorem.text	string	[No params]	[No params]
	lorem.word	string	number\|object	number or { length?: number or { min: number, max: number } }
	lorem.paragraph	string	number\|object	number or { min: number, max: number }
number	number.int	number	number\|object	number or { min?: number, max?: number, multipleOf?: number }
array	array.element	T	array	array
date	date.past	string	object	{ years?: number, refDate?: string | number, separator: string }