random

faker. random

Source:

random.js, line 3

Methods

(static) alpha(options)

alpha. returns lower/upper alpha characters based count and upcase options

Source:

random.js, line 244

Parameters:

Name	Type	Description
`options`	`mixed`	// defaults to { count: 1, upcase: false }

(static) alpha(options)

alpha. returns lower/upper alpha characters based count and upcase options

Source:

random.js, line 244

Parameters:

Name	Type	Description
`options`	`mixed`	// defaults to { count: 1, upcase: false }

(static) alphaNumeric(count)

alphaNumeric

Source:

random.js, line 275

Parameters:

Name	Type	Description
`count`	`number`	defaults to 1

(static) alphaNumeric(count)

alphaNumeric

Source:

random.js, line 275

Parameters:

Name	Type	Description
`count`	`number`	defaults to 1

(static) arrayElement(array)

takes an array and returns a random element of the array

Source:

random.js, line 82

Parameters:

Name	Type	Description
`array`	`array`

(static) arrayElement(array)

takes an array and returns a random element of the array

Source:

random.js, line 82

Parameters:

Name	Type	Description
`array`	`array`

(static) arrayElements(array, count)

takes an array and returns a subset with random elements of the array

Source:

random.js, line 94

Parameters:

Name	Type	Description
`array`	`array`
`count`	`number`	number of elements to pick

(static) arrayElements(array, count)

takes an array and returns a subset with random elements of the array

Source:

random.js, line 94

Parameters:

Name	Type	Description
`array`	`array`
`count`	`number`	number of elements to pick

(static) boolean()

boolean

Source:

random.js, line 152

(static) boolean()

boolean

Source:

random.js, line 152

(static) float(options)

returns a single random floating-point number based on a max number or range

Source:

random.js, line 59

Parameters:

Name	Type	Description
`options`	`mixed`

(static) float(options)

returns a single random floating-point number based on a max number or range

Source:

random.js, line 59

Parameters:

Name	Type	Description
`options`	`mixed`

(static) hexaDecimal(count)

hexaDecimal

Source:

random.js, line 294

Parameters:

Name	Type	Description
`count`	`number`	defaults to 1

(static) hexaDecimal(count)

hexaDecimal

Source:

random.js, line 294

Parameters:

Name	Type	Description
`count`	`number`	defaults to 1

(static) image()

locale

Source:

random.js, line 226

(static) image()

locale

Source:

random.js, line 226

(static) locale()

locale

Source:

random.js, line 235

(static) locale()

locale

Source:

random.js, line 235

(static) number(options)

returns a single random number based on a max number or range

Source:

random.js, line 17

Parameters:

Name	Type	Description
`options`	`mixed`	{min, max, precision}

(static) number(options)

returns a single random number based on a max number or range

Source:

random.js, line 17

Parameters:

Name	Type	Description
`options`	`mixed`	{min, max, precision}

(static) objectElement(object, field)

takes an object and returns the randomly key or value

Source:

random.js, line 122

Parameters:

Name	Type	Description
`object`	`object`
`field`	`mixed`

(static) objectElement(object, field)

takes an object and returns the randomly key or value

Source:

random.js, line 122

Parameters:

Name	Type	Description
`object`	`object`
`field`	`mixed`

(static) uuid()

uuid

Source:

random.js, line 137

(static) uuid()

uuid

Source:

random.js, line 137

(static) word(type)

word

Source:

random.js, line 162

Parameters:

Name	Type	Description
`type`	`string`

(static) word(type)

word

Source:

random.js, line 162

Parameters:

Name	Type	Description
`type`	`string`

(static) words(count)

randomWords

Source:

random.js, line 209

Parameters:

Name	Type	Description
`count`	`number`	defaults to a random value between 1 and 3

(static) words(count)

randomWords

Source:

random.js, line 209

Parameters:

Name	Type	Description
`count`	`number`	defaults to a random value between 1 and 3

faker. random

Source:

random.js, line 3

Methods

(static) alpha(options)

alpha. returns lower/upper alpha characters based count and upcase options

Source:

random.js, line 244

Parameters:

Name	Type	Description
`options`	`mixed`	// defaults to { count: 1, upcase: false }

(static) alpha(options)

alpha. returns lower/upper alpha characters based count and upcase options

Source:

random.js, line 244

Parameters:

Name	Type	Description
`options`	`mixed`	// defaults to { count: 1, upcase: false }

(static) alphaNumeric(count)

alphaNumeric

Source:

random.js, line 275

Parameters:

Name	Type	Description
`count`	`number`	defaults to 1

(static) alphaNumeric(count)

alphaNumeric

Source:

random.js, line 275

Parameters:

Name	Type	Description
`count`	`number`	defaults to 1

(static) arrayElement(array)

takes an array and returns a random element of the array

Source:

random.js, line 82

Parameters:

Name	Type	Description
`array`	`array`

(static) arrayElement(array)

takes an array and returns a random element of the array

Source:

random.js, line 82

Parameters:

Name	Type	Description
`array`	`array`

(static) arrayElements(array, count)

takes an array and returns a subset with random elements of the array

Source:

random.js, line 94

Parameters:

Name	Type	Description
`array`	`array`
`count`	`number`	number of elements to pick

(static) arrayElements(array, count)

takes an array and returns a subset with random elements of the array

Source:

random.js, line 94

Parameters:

Name	Type	Description
`array`	`array`
`count`	`number`	number of elements to pick

(static) boolean()

boolean

Source:

random.js, line 152

(static) boolean()

boolean

Source:

random.js, line 152

(static) float(options)

returns a single random floating-point number based on a max number or range

Source:

random.js, line 59

Parameters:

Name	Type	Description
`options`	`mixed`

(static) float(options)

returns a single random floating-point number based on a max number or range

Source:

random.js, line 59

Parameters:

Name	Type	Description
`options`	`mixed`

(static) hexaDecimal(count)

hexaDecimal

Source:

random.js, line 294

Parameters:

Name	Type	Description
`count`	`number`	defaults to 1

(static) hexaDecimal(count)

hexaDecimal

Source:

random.js, line 294

Parameters:

Name	Type	Description
`count`	`number`	defaults to 1

(static) image()

locale

Source:

random.js, line 226

(static) image()

locale

Source:

random.js, line 226

(static) locale()

locale

Source:

random.js, line 235

(static) locale()

locale

Source:

random.js, line 235

(static) number(options)

returns a single random number based on a max number or range

Source:

random.js, line 17

Parameters:

Name	Type	Description
`options`	`mixed`	{min, max, precision}

(static) number(options)

returns a single random number based on a max number or range

Source:

random.js, line 17

Parameters:

Name	Type	Description
`options`	`mixed`	{min, max, precision}

(static) objectElement(object, field)

takes an object and returns the randomly key or value

Source:

random.js, line 122

Parameters:

Name	Type	Description
`object`	`object`
`field`	`mixed`

(static) objectElement(object, field)

takes an object and returns the randomly key or value

Source:

random.js, line 122

Parameters:

Name	Type	Description
`object`	`object`
`field`	`mixed`

(static) uuid()

uuid

Source:

random.js, line 137

(static) uuid()

uuid

Source:

random.js, line 137

(static) word(type)

word

Source:

random.js, line 162

Parameters:

Name	Type	Description
`type`	`string`

(static) word(type)

word

Source:

random.js, line 162

Parameters:

Name	Type	Description
`type`	`string`

(static) words(count)

randomWords

Source:

random.js, line 209

Parameters:

Name	Type	Description
`count`	`number`	defaults to a random value between 1 and 3

(static) words(count)

randomWords

Source:

random.js, line 209

Parameters:

Name	Type	Description
`count`	`number`	defaults to a random value between 1 and 3