Random #

faker.random.alpha(options: number | {
  bannedChars: readonly string[],
  count: number,
  upcase: boolean
} = {}): string
faker.random.alpha() // => "o"
faker.random.alpha() // 'b'
faker.random.alpha(10) // 'qccrabobaf'
faker.random.alpha({ count: 5, upcase: true, bannedChars: ['a'] }) // 'DTCIC'

faker.random.alphaNumeric(count: number = 1, options: {
  bannedChars: readonly string[]
} = {}): string
faker.random.alphaNumeric() // => "j"
faker.random.alphaNumeric() // '2'
faker.random.alphaNumeric(5) // '3e5v7'
faker.random.alphaNumeric(5, { bannedChars: ["a"] }) // 'xszlm'

faker.random.arrayElement<T>(array: readonly T[] = ['a', 'b', 'c']): T
faker.random.arrayElement() // => "b"
faker.random.arrayElement() // 'b'
faker.random.arrayElement(['cat', 'dog', 'mouse']) // 'dog'

faker.random.arrayElements<T>(array: readonly T[] = ['a', 'b', 'c'], count?: number): T[]
faker.random.arrayElements() // => ["c","b"]
faker.random.arrayElements() // ['b', 'c']
faker.random.arrayElements(['cat', 'dog', 'mouse']) // ['mouse', 'cat']
faker.random.arrayElements([1, 2, 3, 4, 5], 2) // [4, 2]

faker.random.boolean(): boolean
faker.random.boolean() // => true
faker.random.boolean() // false

faker.random.float(options?: number | {
  max: number,
  min: number,
  precision: number
}): number
faker.random.float() // => 54880.8
faker.random.float() // 51696.36
faker.random.float(0.1) // 52023.2
faker.random.float({ min: 1000000 }) // 212859.76
faker.random.float({ max: 100 }) // 28.11
faker.random.float({ precision: 0.1 }) // 84055.3
faker.random.float({ min: 10, max: 100, precision: 0.001 }) // 57.315

faker.random.hexaDecimal(count?: number = 1): string
faker.random.hexaDecimal() // => "0xc"
faker.random.hexaDecimal() // '0xb'
faker.random.hexaDecimal(10) // '0xaE13F044fb'

faker.random.image(): string
faker.random.image() // => "http://loremflickr.com/640/480/fashion"
faker.random.image() // 'http://placeimg.com/640/480/animals'

faker.random.locale(): string
faker.random.locale() // => "hu"
faker.random.locale() // 'el'

faker.random.number(options?: number | {
  max: number,
  min: number,
  precision: number
}): number
faker.random.number() // => 54881
faker.random.number() // 55422
faker.random.number(100) // 52
faker.random.number({ min: 1000000 }) // 431433
faker.random.number({ max: 100 }) // 42
faker.random.number({ precision: 0.01 }) // 64246.18
faker.random.number({ min: 10, max: 100, precision: 0.01 }) // 36.94

faker.random.numeric(length: number = 1, options: {
  allowLeadingZeros: boolean,
  bannedDigits: readonly string[]
} = {}): string
faker.random.numeric() // => "5"
faker.random.numeric() // '2'
faker.random.numeric(5) // '31507'
faker.random.numeric(42) // '56434563150765416546479875435481513188548'
faker.random.numeric(42, { allowLeadingZeros: true }) // '00564846278453876543517840713421451546115'
faker.random.numeric(6, { bannedDigits: ['0'] }) // '943228'

faker.random.objectElement<T, K>(object?: T = { foo: 'bar', too: 'car' }, field?: 'key' | 'value' = 'value'): K | T[K]
faker.random.objectElement() // => "car"
const object = { keyA: 'valueA', keyB: 42 };
faker.random.objectElement(object) // 42
faker.random.objectElement(object, 'key') // 'keyB'
faker.random.objectElement(object, 'value') // 'valueA'

faker.random.uuid(): string
faker.random.uuid() // => "89bd9d8d-69a6-474e-8f46-7cc8796ed151"
faker.random.uuid() // '4136cd0b-d90b-4af7-b485-5d1ded8db252'

faker.random.word(): string
faker.random.word() // => "Montenegro"
faker.random.word() // 'Seamless'

faker.random.words(count?: number): string
faker.random.words() // => "Account Loan"
faker.random.words() // 'neural'
faker.random.words(5) // 'copy Handcrafted bus client-server Point'