faker README

The project's README from github.com/faker-js/faker. As one markdown file: README.md.

Faker

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

npm version npm downloads Continuous Integration codecov Chat on Discord Open Collective sponsor

⚡️ Try it Online

Open in StackBlitz

📙 API Documentation

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

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
v11 (next) https://next.fakerjs.dev/
v10 (stable) https://fakerjs.dev/
v9 (old) https://v9.fakerjs.dev/

🚀 Features

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

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

🪄 Usage

// 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) and v11 (next).

Templates

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

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

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

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 before making a pull request.

📘 Credits

Thanks to all the people who already contributed to Faker!

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

📝 Changelog

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

📜 What happened to the original faker.js?

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

🔑 License

MIT

faker (faker-js/faker)

Searching Database…

15.5K ·GitHub
Faker
Что это такое?Faker — это библиотека для JavaScript/TypeScript, которая генерирует огромные объёмы правдоподобных, но ненастоящих данных — имена, адреса, даты, финансовые записи — для тестирования и разработки, в браузере и в Node.js.
Это библиотека, которую я подключаю в свой код, или онлайн-сервис?Библиотека: вы устанавливаете её из npm и вызываете её генераторы прямо в своём коде на JavaScript или TypeScript. Есть ещё песочница на StackBlitz, если хотите попробовать без установки.
Как добавить её в проект?Установите пакет @faker-js/faker из npm (обычно как dev-зависимость) и импортируйте экземпляр faker. Документация на fakerjs.dev; v10 — стабильный релиз, v11 — следующая версия.
Нужно ли моему окружению что-то особенное для работы?Node.js ^22.13.0, ^23.5.0 или >=24 с npm 10 или новее. У пакета нет ни одной runtime-зависимости, так что в ваше дерево зависимостей он ничего лишнего не добавляет.
Гарантированно ли понятно из данных, что они ненастоящие?Нет — Faker намеренно генерирует правдоподобные данные, поэтому сгенерированные имена, адреса, email и телефоны могут случайно совпасть с данными реальных людей. В README предупреждают: не отправляйте им сообщения и звонки из тестового окружения.
Можно ли бесплатно использовать её в коммерческих проектах?Да — Faker это open source под лицензией MIT, а развитие проекта финансируется спонсорами и жертвователями.
Какие данные он умеет генерировать?Данные о людях (имена, пол, биографии, должности), места (адреса, почтовые индексы, названия улиц, штаты, страны), даты (в прошлом, настоящем, будущем, недавние, скоро), финансы (реквизиты счетов, транзакции, криптоадреса), коммерция (цены, названия товаров, прилагательные, описания), шуточные «хакерские» фразы, а также случайные числа и строки.
Он умеет генерировать данные на других языках?Да — более 70 локалей. Основной экземпляр использует английский; для других языков вы импортируете экземпляр с нужной локалью. Не каждая локаль покрывает каждый модуль, а готовые экземпляры там, где данных не хватает, откатываются на английский, но можно собрать свои экземпляры с другим запасным языком.
Можно ли получать одни и те же «случайные» данные при каждом запуске?Да — задайте свой seed для генератора случайности, и результаты станут стабильными и воспроизводимыми. В README отмечено, что при сидировании методов faker.date есть дополнительные нюансы.
Что случилось с оригинальным faker.js?В README даётся ссылка на обновление от команды от 14 января 2022 года, где это объясняется. Теперь проект продолжается под организацией faker-js, с документацией, примечаниями к релизам и списком изменений на fakerjs.dev.
What are similar projects?faker, faker, msw, json-server, luxon, nock, big-list-of-naughty-strings, ua-parser-js
Which topics is it in?fake, mock, generator, data, localization, npm-package, finance, testing, browser, free, api, nodejs
Creator
faker-js
Size
32.6 MB
Stars
15.5K
Updated
CommitOct 16Releasev10.6.0Aug 14
Age
4y
Commits · 90 Days