Please select the version of the documentation you are looking for.
| Version | Github | Website |
|---|---|---|
| release | releases | https://fakerjs.dev/ |
| dev | next | https://next.fakerjs.dev/ |
| v8.x.x | v8 | https://v8.fakerjs.dev/ |
| v7.x.x | v7 | https://v7.fakerjs.dev/ |
| v6.x.x | v6 | https://v6.fakerjs.dev/ |
- 💌 Locations - Generate valid looking Addresses, Zip Codes, Street Names, States, and Countries!
- ⏰ Time-based Data - Past, present, future, recent, soon... whenever!
- 🌏 Localization - Set a locale to generate realistic looking Names, Addresses, and Phone Numbers.
- 💸 Finance - Create stubbed out Account Details, Transactions, and Crypto Addresses.
- 👠 Products - Generate Prices, Product Names, Adjectives, and Descriptions.
- 👾 Hacker Jargon - “Try to reboot the SQL bus, maybe it will bypass the virtual application!”
- 🧍 Names - Generate virtual humans with a complete online and offline identity.
- 🔢 Numbers - Of course, we can also generate random numbers and strings.
Note: Faker tries to generate realistic data and not obvious fake data. The generated names, addresses, emails, phone numbers, and/or other data might be coincidentally valid information. Please do not send any of your messages/calls to them from your test setup.
npm install --save-dev @faker-js/fakerimport { faker } from '@faker-js/faker';
// import { faker } from '@faker-js/faker/locale/de';
export const USERS: User[] = [];
export function createRandomUser(): User {
return {
userId: faker.datatype.uuid(),
username: faker.internet.userName(),
email: faker.internet.email(),
avatar: faker.image.avatar(),
password: faker.internet.password(),
birthdate: faker.date.birthdate(),
registeredAt: faker.date.past(),
};
}
Array.from({ length: 10 }).forEach(() => {
USERS.push(createRandomUser());
});The above code indicates a basic usage of Faker. The point of interest is the import statements at the top. The first import indicates how one can import the entirety of Faker, which includes every locale, while the commented-out import showcases how to import only a single locale. In most situations, importing a single locale is preferable for performance because some testing frameworks reload imports for every test file, which causes startup latencies to add up quickly. Thus, limiting the import to a single locale can speed up startup times.
An in-depth overview of the API methods is available in the documentation.
The API covers the following modules:
| Module | Example | Output |
|---|---|---|
| Airline | faker.airline.airport() |
{ name: 'Dallas Fort Worth International Airport', iataCode: 'DFW' } |
| Animal | faker.animal.cat() |
Norwegian Forest Cat |
| Color | faker.color.rgb() |
#cdfcdc |
| Commerce | faker.commerce.product() |
Polo t-shirt |
| Company | faker.company.companyName() |
Zboncak and Sons |
| Database | faker.database.engine() |
MyISAM |
| Datatype | faker.datatype.uuid() |
7b16dd12-935e-4acc-8381-b1e457bf0176 |
| Date | faker.date.past() |
Sat Oct 20 2018 04:19:38 GMT-0700 (Pacific Daylight Time) |
| Finance | faker.finance.amount() |
¥23400 (After setting locale) |
| Git | faker.git.commitMessage() |
feat: add products list page |
| Hacker | faker.hacker.phrase() |
Try to reboot the SQL bus, maybe it will bypass the virtual application! |
| Helpers | faker.helpers.arrayElement(['a', 'b', 'c']) |
b |
| Image | faker.image.url() |
https://picsum.photos/id/165/640/480 |
| Internet | faker.internet.domainName() |
muddy-neuropathologist.net |
| Location | faker.location.city() |
Lake Raoulfort |
| Lorem | faker.lorem.paragraph() |
Porro nulla id vero perspiciatis nulla nihil. ... |
| Music | faker.music.genre() |
R&B |
| Person | faker.person.firstName() |
Cameron |
| Phone | faker.phone.phoneNumber() |
+1 291-299-0192 |
| Random | faker.random.locale() |
fr_CA |
| Science | faker.science.unit() |
{ name: 'meter', symbol: 'm' } |
| System | faker.system.directoryPath() |
/root |
| Vehicle | faker.vehicle.vehicle() |
Lamborghini Camry |
| Word | faker.word.adjective() |
adorable |
Faker contains a generator method faker.helpers.fake for combining faker API methods using a mustache string format.
console.log(
faker.helpers.fake(
'Hello {{person.prefix}} {{person.lastName}}, how are you today?'
)
);Faker has support for multiple locales.
The default language locale is set to English.
Setting a new locale is simple:
// sets locale to de
faker.locale = 'de';See our documentation for a list of provided languages
Please note: not every locale provides data for every module. In our pre-made locales, we fallback to English in such a case as this is the most complete and most commonly used language.
If you want consistent results, you can set your own seed:
faker.seed(123);
const firstRandom = faker.number.int();
// Setting the seed again resets the sequence.
faker.seed(123);
const secondRandom = faker.number.int();
console.log(firstRandom === secondRandom);Faker is an MIT-licensed open source project with its ongoing development made possible entirely by the support of these awesome backers
Please make sure to read the Contributing Guide before making a pull request.
Thanks to all the people who already contributed to Faker!
The fakerjs.dev website is kindly hosted by the Netlify Team. Also the search functionality is powered by algolia.
Detailed changes for each release are documented in the release notes.
Read the team update (January 14th, 2022).