Faker

Getting Started

Overview

Faker is a popular library that generates fake (but reasonable) data that can be used for things such as:

  • Unit Testing
  • Performance Testing
  • Building Demos
  • Working without a completed backend

Faker was originally written in Perl and this is the JavaScript port. Language bindings also exist for Ruby, Java, and Python.

This documentation only covers the JavaScript implementation of Faker.

Environments

You can run Faker in the Browser, within Node, or the many other languages supported by Faker. (Perl, Ruby, Java, and Python)

Installation

Install it as a Dev Dependency using your favorite package manager.

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

or

yarn add @faker-js/faker --dev

or

pnpm add @faker-js/faker --save-dev

Usage

Node.js 

import { faker } from '@faker-js/faker';

const randomName = faker.name.findName(); // Rowan Nikolaus
const randomEmail = faker.internet.email(); // Kassandra.Haley@erich.biz
const randomCard = faker.helpers.createCard(); // An object representing a random contact card containing many properties

Browser 

<script type="text/javascript" src="https://unpkg.com/@faker-js/faker"></script>

<script>
  // Caitlyn Kerluke
  const randomName = faker.name.findName();

  // Rusty@arne.info
  const randomEmail = faker.internet.email();

  // An object representing a random contact card
  // containing many properties
  const randomCard = faker.helpers.createCard();
</script>

Note

Using the browser is great for experimenting 👍. However, due to all of the strings Faker uses to generate fake data, Faker is a large package. It's > 5 MiB minified. Please avoid deploying Faker in your web app.

CDN/Deno 

import { faker } from 'https://cdn.skypack.dev/@faker-js/faker';

const randomName = faker.name.findName(); // Willie Bahringer
const randomEmail = faker.internet.email(); // Tomasa_Ferry14@hotmail.com
const randomCard = faker.helpers.createCard(); // random contact card containing many properties

Note

It is highly recommended to use version tags when importing libraries in Deno, e.g: import { faker } from "https://cdn.skypack.dev/@faker-js/faker@v6.0.0". Add ?dts to import with type definitions: import { faker } from "https://cdn.skypack.dev/@faker-js/faker@v6.0.0?dts".

esm:

cjs:

Community

If you have questions or need help, reach out to the community via Discord and GitHub Discussions.