Class Faker

This is the faker module's main class containing all generators that can be used to generate data.

Please have a look at the individual generators and methods for more information.

Example

import { Faker } from "k6/x/faker"

const faker = new Faker(11)

export default function() {
  console.log(faker.person.firstName())
}

Output (formatted as JSON value)

"Josiah"

Constructors

constructor

Properties

address animal app beer book car celebrity color company emoji error file finance food game hacker hipster internet language minecraft movie numbers payment person product strings time word zen

Methods

call

Constructors

constructor

  • new Faker(seed?): Faker

  • Creates a new instance of Faker.

    Optionally, the value of the random seed can be set as a constructor parameter. This is intended to allow for consistent values in a tests, so you might want to use hardcoded values as the seed.

    Please note that generated values are dependent on both the seed and the number of calls that have been made.

    Setting seed to 0 (or omitting it) will use seed derived from system entropy.

    Parameters

    • Optionalseed: number

      random seed value for deterministic generator

    Returns Faker

    Example

    const consistentFaker = new Faker(11)
    const semiRandomFaker = new Faker()

Properties

Readonlyaddress

address: Address

Generator to generate addresses and locations.

Readonlyanimal

animal: Animal

Generator to generate animals.

Readonlyapp

app: App

Generator to generate application related entries.

Readonlybeer

beer: Beer

Generator to generate beer related entries.

Readonlybook

book: Book

Generator to generate book related entries.

Readonlycar

car: Car

Generator to generate car related entries.

Readonlycelebrity

celebrity: Celebrity

Generator to generate celebrities.

Readonlycolor

color: Color

Generator to generate colors.

Readonlycompany

company: Company

Generator to generate company related entries.

Readonlyemoji

emoji: Emoji

Generator to generate emoji related entries.

Readonlyerror

error: Error

Generator to generate various error codes and messages.

Readonlyfile

file: File

Generator to generate file related entries.

Readonlyfinance

finance: Finance

Generator to generate finance related entries.

Readonlyfood

food: Food

Generator to generate food related entries.

Readonlygame

game: Game

Generator to generate game related entries.

Readonlyhacker

hacker: Hacker

Generator to generate hacker/IT words and phrases.

Readonlyhipster

hipster: Hipster

Generator to generate hipster words, phrases and paragraphs.

Readonlyinternet

internet: Internet

Generator to generate internet related entries.

Readonlylanguage

language: Language

Generator to generate language related entries.

Readonlyminecraft

minecraft: Minecraft

Generator to generate minecraft related entries.

Readonlymovie

movie: Movie

Generator to generate movie related entries.

Readonlynumbers

numbers: Numbers

Generator to generate numbers.

Readonlypayment

payment: Payment

Generator to generate payment related entries.

Readonlyperson

person: Person

Generator to generate people's personal information.

Readonlyproduct

product: Product

Generator to generate product related entries.

Readonlystrings

strings: Strings

Generator to generate strings.

Readonlytime

time: Time

Generator to generate time and date.

Readonlyword

word: Word

Generator to generate words and sentences.

Readonlyzen

zen: Zen

Generator with all generator functions for convenient use.

Methods

call

  • call(func, ...args): unknown

  • Call fake data generator function based on function name.

    Parameters

    • func: string

      the name of the generator function to be called

    • Rest...args: unknown[]

      parameters for the generator function to be called

    Returns unknown

Settings

On This Page

Constructors
Properties
Methods