This is a much smaller version of faker-js that is meant to only support english mock-data generation.
Each method can be imported on its own so that the impact to your project's bundle is limited.
This is still a work in progress so many of the features from faker-js are still missing.
faker-en is a package that generates usable random data in English. It exports the following methods:
This submodule contains methods for generating random data related to people. To use these methods, you can import them like this:
import { firstName, fullName, lastName, phoneNumber } from "faker-en/person";
const groom = {
firstName: firstName("male"),
lastName: lastName(),
phoneNumber: phoneNumber(),
};
const bride = {
firstName: firstName("female"),
lastName: lastName(),
phoneNumber: phoneNumber(),
};import { firstName } from "faker-en/person/firstName";gender?: Gender - optional, either 'male' or 'female'. Random by default.
Generates a random first name for a person.
import { fullName } from "faker-en/person/fullName";gender?: Gender - optional, either 'male' or 'female'. Random by default.
Generates a random full name for a person, including a first name and last name.
import { lastName } from "faker-en/person/lastName";This function accepts no parameters
Generates a random last name for a person.
import { phoneNumber } from "faker-en/person/phoneNumber";-
props?: PhoneNumberProps- optional, an object containing the following properties:props.areaCode?: string- optional, a string containing the area code for the phone number. Random by default.props.format?: PhoneFormat- optional, a string containing the format for the phone number. The options are"standard" | "business" | "international" | "plain""standard":212-555-5555"business":(212) 555-5555"international":+1 212-555-5555"plain":2125555555
Generates a random phone number for a person.
This submodule contains utility methods that are used by other methods in faker-en. To use these methods, you can import them like this:
import {
arrayElement,
arrayElements,
gender,
randomNumber,
shuffle,
} from "faker-en/utils";import { arrayElement } from "faker-en/utils/arrayElement";array- an array of any type
Returns a random element from an array.
import { arrayElements } from "faker-en/utils/arrayElements";array- an array of any typecount- the number of elements to return. (min:0, max:array.length) Returns a specified number of random elements from an array.
Returns a specified number of random elements from an array.
import { gender } from "faker-en/utils/gender";exact?: Gender:"male"or"female". If this is provided then the function will return this value
Returns a random gender (either "male" or "female").
import { randomNumber } from "faker-en/utils/randomNumber";opts: RandomNumberProps- an object with the following properties. Required.opts.min: number- the minimum value for the random number. Optional. Defaults to 0.opts.max: number- the maximum value for the random number. Required.
Generates a random number within a specified range.
import { shuffle } from "faker-en/utils/shuffle";array: any[]- An array of any type
Randomly shuffles the order of elements of an array.
This submodule contains methods for generating random words:
import { word, noun, verb } from "faker-en/word";
const randomWord = word();
const item = noun();
const action = verb();import { noun } from "faker-en/word/noun";This function accepts no parameters
Generates a random noun
import { verb } from "faker-en/word/verb";This function accepts no parameters
Generates a random verb.