Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/faker-js/faker

Generate massive amounts of fake data in the browser and node.js
https://github.com/faker-js/faker

browser data fake faker javascript nodejs

Last synced: 4 days ago
JSON representation

Generate massive amounts of fake data in the browser and node.js

Awesome Lists containing this project

README 

        


  

  
Faker


  
Generate massive amounts of fake (but realistic) data for testing and development.


  

  [![npm version](https://badgen.net/npm/v/@faker-js/faker)](https://www.npmjs.com/package/@faker-js/faker)

  [![npm downloads](https://badgen.net/npm/dm/@faker-js/faker)](https://www.npmjs.com/package/@faker-js/faker)

  [![Continuous Integration](https://github.com/faker-js/faker/actions/workflows/ci.yml/badge.svg)](https://github.com/faker-js/faker/actions/workflows/ci.yml)

  [![codecov](https://codecov.io/gh/faker-js/faker/branch/next/graph/badge.svg?token=N61U168G08)](https://codecov.io/gh/faker-js/faker)

  [![Chat on Discord](https://img.shields.io/badge/chat-discord-blue?style=flat&logo=discord)](https://chat.fakerjs.dev)

  [![Open Collective](https://img.shields.io/opencollective/backers/fakerjs)](https://opencollective.com/fakerjs#section-contributors)

  [![sponsor](https://img.shields.io/opencollective/all/fakerjs?label=sponsors)](https://opencollective.com/fakerjs)




## ⚡️ Try it Online



[Open in StackBlitz](https://fakerjs.dev/new)



## 📙 API Documentation



⚠️ You are reading the docs for the next branch ⚠️



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                   |

| :---------: | :------------------------ |

|  v9 (next)  | https://next.fakerjs.dev/ |

| v9 (stable) | https://fakerjs.dev/      |

|  v8 (old)   | https://v8.fakerjs.dev/   |



---



## 🚀 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 60 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(), // before version 9.1.0, use 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 [v9 (stable)](https://fakerjs.dev/api/) and [v9.\* (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



![](https://opencollective.com/fakerjs/organizations.svg)



### Backers



![](https://opencollective.com/fakerjs/individuals.svg)



## ✨ 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!






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://fakerjs.dev/update.html) (January 14th, 2022).



## 🔑 License



[MIT](https://github.com/faker-js/faker/blob/next/LICENSE)