Repository: faker-js/faker

Stars: 15003

README.md Copy Chapter

<div align="center">
<img src="./docs/public/logo.svg" width="200"/>
<h1>Faker</h1>
<p>Generate massive amounts of fake (but realistic) data for testing and development.</p>

</div>

⚡️ Try it Online Copy Chapter

Open in StackBlitz

📙 API Documentation Copy Chapter

<h1>⚠️ You are reading the docs for the <a href="https://github.com/faker-js/faker/tree/next">next</a> branch ⚠️</h1>

Please proceed to the Getting Started Guide for the stable release of Faker.

For detailed API documentation, please select the version of the documentation you are looking for.

| Version | Website |
| :----------: | :------------------------ |
| v10 (next) | https://next.fakerjs.dev/ |
| v10 (stable) | https://fakerjs.dev/ |
| v9 (old) | https://v9.fakerjs.dev/ |

---

🚀 Features Copy Chapter

- 🧍 Person - Generate Names, Genders, Bios, Job titles, and more.
- 📍 Location - Generate Addresses, Zip Codes, Street Names, States, and Countries!
- ⏰ Date - Past, present, future, recent, soon... whenever!
- 💸 Finance - Create stubbed out Account Details, Transactions, and Crypto Addresses.
- 👠 Commerce - Generate Prices, Product Names, Adjectives, and Descriptions.
- 👾 Hacker - “Try to reboot the SQL bus, maybe it will bypass the virtual application!”
- 🔢 Number and String - Of course, we can also generate random numbers and strings.
- 🌏 Localization - Pick from over 70 locales to generate realistic looking Names, Addresses, and Phone Numbers.

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.

📦 Install Copy Chapter

npm install --save-dev @faker-js/faker

🪄 Usage Copy Chapter

// ESM
import { faker } from '@faker-js/faker';
// CJS
const { faker } = require('@faker-js/faker');
export function createRandomUser() {
  return {
    userId: faker.string.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(),
  };
}
export const users = faker.helpers.multiple(createRandomUser, {
  count: 5,
});

💎 Modules Copy Chapter

An in-depth overview of the API methods is available in the documentation for v10 (stable) and v10.\* (next).

Templates Copy Section

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?'
  )
);

🌏 Localization Copy Chapter

Faker has support for multiple locales.

The main faker instance uses the English locale.
But you can also import instances using other locales.

// ESM
import { fakerDE as faker } from '@faker-js/faker';
// CJS
const { fakerDE: faker } = require('@faker-js/faker');

See our documentation for a list of provided languages.

Please note: Not every locale provides data for every module. In our pre-made faker instances,
we fall back to English in such a case as this is the most complete and most commonly used language.
If you don't want that or prefer a different fallback, you can also build your own instances.

import { de, de_CH, Faker } from '@faker-js/faker';
export const faker = new Faker({
  locale: [de_CH, de],
});

⚙️ Setting a randomness seed Copy Chapter

If you want consistent results, you can set your own seed. If you are using faker.date methods, there are additional considerations. See Reproducible Results.

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);

🤝 Sponsors Copy Chapter

Faker is an MIT-licensed open source project with its ongoing development made possible entirely by the support of these awesome backers

Sponsors Copy Section


Backers Copy Section


✨ Contributing Copy Chapter

Please make sure to read the Contributing Guide before making a pull request.

📘 Credits Copy Chapter

Thanks to all the people who already contributed to Faker!

<a href="https://github.com/faker-js/faker/graphs/contributors"><img src="https://opencollective.com/fakerjs/contributors.svg?width=800" /></a>

The fakerjs.dev website is generously hosted by Netlify, with search functionality powered by Algolia.

📝 Changelog Copy Chapter

Detailed changes for each release are documented in the release notes.

📜 What happened to the original faker.js? Copy Chapter

Read the team update (January 14th, 2022).

🔑 License Copy Chapter

MIT