@faker-js/faker
Version:
Generate massive amounts of fake contextual data
168 lines (113 loc) • 5.87 kB
Markdown
<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>
[](https://www.npmjs.com/package/@faker-js/faker)
[](https://www.npmjs.com/package/@faker-js/faker)
[](https://github.com/faker-js/faker/actions/workflows/ci.yml)
[](https://codecov.io/gh/faker-js/faker)
[](https://chat.fakerjs.dev)
[](https://opencollective.com/fakerjs#section-contributors)
[](https://opencollective.com/fakerjs)
</div>
## ⚡️ Try it Online
[Open in StackBlitz](https://v10.fakerjs.dev/new)
## 📙 API Documentation
- [Getting Started Guide](https://v10.fakerjs.dev/guide/)
- [API Reference](https://v10.fakerjs.dev/api/)
## 🚀 Features
- 🧍 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
```bash
npm install --save-dev @faker-js/faker
```
## 🪄 Usage
```ts
// 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
An in-depth overview of the API methods is available in the documentation for [v10 (stable)](https://v10.fakerjs.dev/api/) and [v10.\* (next)](https://next.fakerjs.dev/api/).
### Templates
Faker contains a generator method `faker.helpers.fake` for combining faker API methods using a mustache string format.
```ts
console.log(
faker.helpers.fake(
'Hello {{person.prefix}} {{person.lastName}}, how are you today?'
)
);
```
## 🌏 Localization
Faker has support for multiple locales.
The main `faker` instance uses the English locale.
But you can also import instances using other locales.
```ts
// 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](https://v10.fakerjs.dev/guide/localization.html#available-locales).
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.
```ts
import { de, de_CH, Faker } from '@faker-js/faker';
export const faker = new Faker({
locale: [de_CH, de],
});
```
## ⚙️ Setting a randomness seed
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](https://v10.fakerjs.dev/guide/usage.html#reproducible-results).
```ts
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
Faker is an MIT-licensed open source project with its ongoing development made possible entirely by the support of these awesome backers
### Sponsors
### Backers
## ✨ Contributing
Please make sure to read the [Contributing Guide](https://github.com/faker-js/faker/blob/next/CONTRIBUTING.md) before making a pull request.
## 📘 Credits
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](https://fakerjs.dev) website is generously hosted by [Netlify](https://www.netlify.com/), with search functionality powered by [Algolia](https://www.algolia.com/).
## 📝 Changelog
Detailed changes for each release are documented in the [release notes](https://github.com/faker-js/faker/blob/next/CHANGELOG.md).
## 📜 What happened to the original faker.js?
Read the [team update](https://v10.fakerjs.dev/update.html) (January 14th, 2022).
## 🔑 License
[MIT](https://github.com/faker-js/faker/blob/next/LICENSE)