minifaker

minifaker

Generate fake data.
An alternative to faker.js but with cjs or esm syntax

NPM

npm i minifaker

Why

faker.js is too big and there is no tree shaking. https://github.com/Marak/faker.js/issues/785

Why not create a pull request to faker.js?

Too much work to get the pull request denied. Instead, I will be adding new functions here from time to time.

Better alternatives

I will deprecate functions with better alternatives. use npm i nanoid to generate string ID use npm i lorem-ipsum to generate lorem words

Duplicates

I've notice that faker locales have duplicate words :S.
I will remove the duplicates when importing locale files to reduce size as much as possible.

Example / usage

Using functions

// You can either import minifaker completely or import the functions you need
import minifaker, { arrayElement } from 'minifaker'
// const minifaker = require('minifaker')

minifaker.number()
arrayElement(['one', 'two', 'three'])

Using locale dependent functions

import minifaker, { cityName } from 'minifaker'
import 'minifaker/dist/locales/en' // first import is set a default locale
import 'minifaker/dist/locales/fr'

minifaker.firstName({ gender: 'female' }) // female name in english
cityName({ locale: 'fr' }) // french city name

Function mapping

Function	Locales	Faker.js
arrayElement	n/a	arrayElement
number	n/a	number,float
boolean	n/a	boolean
use nanoid	n/a	uuid
firstName	en,fr	firstName
phoneNumber	en,fr,fr_CA	phoneNumber
cityName	en,fr	cityName
cityPrefix	en	cityPrefix
citySufix	en	citySufix
imageUrlFromPlaceIMG	n/a	imageUrl
imageUrlFromPlaceholder	n/a	imageUrl
use lorem-ipsum.js	n/a	lorem
objectElement	n/a	objectElement
array	n/a	n/a