mirror of
https://github.com/arthur-pbty/portfolio2023.git
synced 2026-06-03 15:07:33 +02:00
Tutur33
179 lines
6.0 KiB
Markdown
179 lines
6.0 KiB
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://fakerjs.dev/new)
|
|
|
|
## 📙 API Documentation
|
|
|
|
<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](https://fakerjs.dev/guide/) for the **stable** release of Faker.
|
|
|
|
For detailed API documentation, please select the version of the documentation you are looking for.
|
|
|
|
| Version | Website |
|
|
| :----------: | :------------------------ |
|
|
| v8.\* (next) | https://next.fakerjs.dev/ |
|
|
| v8 (stable) | https://fakerjs.dev/ |
|
|
| v7 (old) | https://v7.fakerjs.dev/ |
|
|
|
|
---
|
|
|
|
## 🚀 Features
|
|
|
|
- 💌 Locations - Generate valid looking Addresses, Zip Codes, Street Names, States, and Countries!
|
|
- ⏰ Time-based Data - Past, present, future, recent, soon... whenever!
|
|
- 🌏 Localization - Pick 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.
|
|
|
|
## 📦 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(): User {
|
|
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: User[] = faker.helpers.multiple(createRandomUser, {
|
|
count: 5,
|
|
});
|
|
```
|
|
|
|
## 💎 Modules
|
|
|
|
An in-depth overview of the API methods is available in the documentation for [v8 (stable)](https://fakerjs.dev/api/) and [v8.\* (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://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:
|
|
|
|
```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 kindly hosted by the Netlify Team. Also the search functionality is 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://fakerjs.dev/update.html) (January 14th, 2022).
|
|
|
|
## 🔑 License
|
|
|
|
[MIT](https://github.com/faker-js/faker/blob/next/LICENSE)
|