Skip to content

Latest commit

 

History

History
2212 lines (1239 loc) · 33.8 KB

faker.md

File metadata and controls

2212 lines (1239 loc) · 33.8 KB

Class: Faker

Table of contents

Constructors

Methods

Constructors

constructor

+ new Faker(seed?: number): Faker

Create new Faker instance.

Parameters

Name Type Description
seed? number random seed value for deterministic generator

Returns: Faker

Methods

achAccount

▸ achAccount(): string

achAccount will generate a 12 digit account number

Returns: string

achRouting

▸ achRouting(): string

achRouting will generate a 9 digit routing number

Returns: string

address

▸ address(): Address

address will generate a struct of address information

Returns: Address

adjective

▸ adjective(): string

adjective will generate a random adjective

Returns: string

adverb

▸ adverb(): string

adverb will generate a random adverb

Returns: string

animal

▸ animal(): string

animal will return a random animal

Returns: string

animalType

▸ animalType(): string

animalType will return a random animal type

Returns: string

appAuthor

▸ appAuthor(): string

appAuthor will generate a random company or person name

Returns: string

appName

▸ appName(): string

appName will generate a random app name

Returns: string

appVersion

▸ appVersion(): string

appVersion will generate a random app version

Returns: string

beerAlcohol

▸ beerAlcohol(): string

beerAlcohol will return a random beer alcohol level between 2.0 and 10.0

Returns: string

beerBlg

▸ beerBlg(): string

beerBlg will return a random beer blg between 5.0 and 20.0

Returns: string

beerHop

▸ beerHop(): string

beerHop will return a random beer hop

Returns: string

beerIbu

▸ beerIbu(): string

beerIbu will return a random beer ibu value between 10 and 100

Returns: string

beerMalt

▸ beerMalt(): string

beerMalt will return a random beer malt

Returns: string

beerName

▸ beerName(): string

beerName will return a random beer name

Returns: string

beerStyle

▸ beerStyle(): string

beerStyle will return a random beer style

Returns: string

beerYeast

▸ beerYeast(): string

beerYeast will return a random beer yeast

Returns: string

bitcoinAddress

▸ bitcoinAddress(): string

bitcoinAddress will generate a random bitcoin address consisting of numbers, upper and lower characters

Returns: string

bitcoinPrivateKey

▸ bitcoinPrivateKey(): string

bitcoinPrivateKey will generate a random bitcoin private key base58 consisting of numbers, upper and lower characters

Returns: string

bool

▸ bool(): boolean

bool will generate a random boolean value

Returns: boolean

breakfast

▸ breakfast(): string

breakfast will return a random breakfast name

Returns: string

bs

▸ bs(): string

bs will generate a random company bs string

Returns: string

buzzWord

▸ buzzWord(): string

buzzWord will generate a random company buzz word string

Returns: string

car

▸ car(): Car

car will generate a struct with car information

Returns: Car

carFuelType

▸ carFuelType(): string

carFuelType will return a random fuel type

Returns: string

carMaker

▸ carMaker(): string

carMaker will return a random car maker

Returns: string

carModel

▸ carModel(): string

carModel will return a random car model

Returns: string

carTransmissionType

▸ carTransmissionType(): string

carTransmissionType will return a random transmission type

Returns: string

carType

▸ carType(): string

carType will generate a random car type string

Returns: string

cat

▸ cat(): string

cat will return a random cat breed

Returns: string

chromeUserAgent

▸ chromeUserAgent(): string

chromeUserAgent will generate a random chrome browser user agent string

Returns: string

city

▸ city(): string

city will generate a random city string

Returns: string

color

▸ color(): string

color will generate a random color string

Returns: string

company

▸ company(): string

company will generate a random company name string

Returns: string

companySuffix

▸ companySuffix(): string

companySuffix will generate a random company suffix string

Returns: string

contact

▸ contact(): Contact

contact will generate a struct with information randomly populated contact information

Returns: Contact

country

▸ country(): string

country will generate a random country string

Returns: string

countryAbr

▸ countryAbr(): string

countryAbr will generate a random abbreviated country string

Returns: string

creditCard

▸ creditCard(): CreditCard

creditCard will generate a struct full of credit card information

Returns: CreditCard

creditCardCvv

▸ creditCardCvv(): string

creditCardCvv will generate a random CVV number Its a string because you could have 017 as an exp date

Returns: string

creditCardExp

▸ creditCardExp(): string

creditCardExp will generate a random credit card expiration date string Exp date will always be a future date

Returns: string

creditCardNumber

▸ creditCardNumber(opts?: CreditCardOptions): string

creditCardNumber will generate a random luhn credit card number

Parameters

Name Type
opts? CreditCardOptions

Returns: string

creditCardType

▸ creditCardType(): string

creditCardType will generate a random credit card type string

Returns: string

currency

▸ currency(): Currency

currency will generate a struct with random currency information

Returns: Currency

currencyLong

▸ currencyLong(): string

currencyLong will generate a random long currency name

Returns: string

currencyShort

▸ currencyShort(): string

currencyShort will generate a random short currency value

Returns: string

date

▸ date(): Date

date will generate a random time.Time struct

Returns: Date

dateRange

▸ dateRange(start: Date, end: Date): Date

dateRange will generate a random time.Time struct between a start and end date

Parameters

Name Type
start Date
end Date

Returns: Date

day

▸ day(): number

day will generate a random day between 1 - 31

Returns: number

dessert

▸ dessert(): string

dessert will return a random dessert name

Returns: string

digit

▸ digit(): string

digit will generate a single ASCII digit

Returns: string

digitN

▸ digitN(m: number): string

digitN will generate a random string of length N consists of ASCII digits (note it can start with 0).

Parameters

Name Type
m number

Returns: string

dinner

▸ dinner(): string

dinner will return a random dinner name

Returns: string

dog

▸ dog(): string

dog will return a random dog breed

Returns: string

domainName

▸ domainName(): string

domainName will generate a random url domain name

Returns: string

domainSuffix

▸ domainSuffix(): string

domainSuffix will generate a random domain suffix

Returns: string

email

▸ email(): string

email will generate a random email string

Returns: string

emoji

▸ emoji(): string

emoji will return a random fun emoji

Returns: string

emojiAlias

▸ emojiAlias(): string

emojiAlias will return a random fun emoji alias

Returns: string

emojiCategory

▸ emojiCategory(): string

emojiCategory will return a random fun emoji category

Returns: string

emojiDescription

▸ emojiDescription(): string

emojiDescription will return a random fun emoji description

Returns: string

emojiTag

▸ emojiTag(): string

emojiTag will return a random fun emoji tag

Returns: string

farmAnimal

▸ farmAnimal(): string

farmAnimal will return a random animal that usually lives on a farm

Returns: string

fileExtension

▸ fileExtension(): string

fileExtension will generate a random file extension

Returns: string

fileMimeType

▸ fileMimeType(): string

fileMimeType will generate a random mime file type

Returns: string

firefoxUserAgent

▸ firefoxUserAgent(): string

firefoxUserAgent will generate a random firefox broswer user agent string

Returns: string

firstName

▸ firstName(): string

firstName will generate a random first name

Returns: string

flipACoin

▸ flipACoin(): string

flipACoin will return a random value of Heads or Tails

Returns: string

float32

▸ float32(): number

float32 will generate a random float32 value

Returns: number

float32Range

▸ float32Range(min: number, max: number): number

float32Range will generate a random float32 value between min and max

Parameters

Name Type
min number
max number

Returns: number

float64

▸ float64(): number

float64 will generate a random float64 value

Returns: number

float64Range

▸ float64Range(min: number, max: number): number

float64Range will generate a random float64 value between min and max

Parameters

Name Type
min number
max number

Returns: number

fruit

▸ fruit(): string

fruit will return a random fruit name

Returns: string

gamertag

▸ gamertag(): string

gamertag will generate a random video game username

Returns: string

gender

▸ gender(): string

gender will generate a random gender string

Returns: string

generate

▸ generate(dataVal: string): string

Generate fake information from given string. Replaceable values should be within {}

Functions

  • {firstname} - billy
  • {sentence:3} - Record river mind.
  • {number:1,10} - 4
  • {uuid} - 590c1440-9888-45b0-bd51-a817ee07c3f2

Letters/Numbers

  • random numbers: ### - 481
  • random letters: ??? - fda

Parameters

Name Type Description
dataVal string template string

Returns: string

hackerAbbreviation

▸ hackerAbbreviation(): string

hackerAbbreviation will return a random hacker abbreviation

Returns: string

hackerAdjective

▸ hackerAdjective(): string

hackerAdjective will return a random hacker adjective

Returns: string

hackerNoun

▸ hackerNoun(): string

hackerNoun will return a random hacker noun

Returns: string

hackerPhrase

▸ hackerPhrase(): string

hackerPhrase will return a random hacker sentence

Returns: string

hackerVerb

▸ hackerVerb(): string

hackerVerb will return a random hacker verb

Returns: string

hackeringVerb

▸ hackeringVerb(): string

hackeringVerb will return a random hacker ingverb

Returns: string

hexColor

▸ hexColor(): string

hexColor will generate a random hexadecimal color string

Returns: string

hipsterParagraph

▸ hipsterParagraph(paragraphCount: number, sentenceCount: number, wordCount: number, separator: string): string

hipsterParagraph will generate a random paragraphGenerator Set Paragraph Count Set Sentence Count Set Word Count Set Paragraph Separator

Parameters

Name Type
paragraphCount number
sentenceCount number
wordCount number
separator string

Returns: string

hipsterSentence

▸ hipsterSentence(wordCount: number): string

hipsterSentence will generate a random sentence

Parameters

Name Type
wordCount number

Returns: string

hipsterWord

▸ hipsterWord(): string

hipsterWord will return a single hipster word

Returns: string

hour

▸ hour(): number

hour will generate a random hour - in military time

Returns: number

httpMethod

▸ httpMethod(): string

httpMethod will generate a random http method

Returns: string

httpStatusCode

▸ httpStatusCode(): number

httpStatusCode will generate a random status code

Returns: number

httpStatusCodeSimple

▸ httpStatusCodeSimple(): number

httpStatusCodeSimple will generate a random simple status code

Returns: number

imageJpeg

▸ imageJpeg(width: number, height: number): ArrayBuffer

imageJpeg generates a random rgba jpeg image

Parameters

Name Type
width number
height number

Returns: ArrayBuffer

imagePng

▸ imagePng(width: number, height: number): ArrayBuffer

imagePng generates a random rgba png image

Parameters

Name Type
width number
height number

Returns: ArrayBuffer

imageURL

▸ imageURL(width: number, height: number): string

imageURL will generate a random Image Based Upon Height And Width. https://picsum.photos/

Parameters

Name Type
width number
height number

Returns: string

int16

▸ int16(): number

int16 will generate a random int16 value

Returns: number

int32

▸ int32(): number

int32 will generate a random int32 value

Returns: number

int64

▸ int64(): number

int64 will generate a random int64 value

Returns: number

int8

▸ int8(): number

int8 will generate a random Int8 value

Returns: number

ipv4Address

▸ ipv4Address(): string

ipv4Address will generate a random version 4 ip address

Returns: string

ipv6Address

▸ ipv6Address(): string

ipv6Address will generate a random version 6 ip address

Returns: string

job

▸ job(): Job

job will generate a struct with random job information

Returns: Job

jobDescriptor

▸ jobDescriptor(): string

jobDescriptor will generate a random job descriptor string

Returns: string

jobLevel

▸ jobLevel(): string

jobLevel will generate a random job level string

Returns: string

jobTitle

▸ jobTitle(): string

jobTitle will generate a random job title string

Returns: string

language

▸ language(): string

language will return a random language

Returns: string

languageAbbreviation

▸ languageAbbreviation(): string

languageAbbreviation will return a random language abbreviation

Returns: string

lastName

▸ lastName(): string

lastName will generate a random last name

Returns: string

latitude

▸ latitude(): number

latitude will generate a random latitude float64

Returns: number

latitudeInRange

▸ latitudeInRange(min: number, max: number): number

latitudeInRange will generate a random latitude within the input range

Parameters

Name Type
min number
max number

Returns: number

letter

▸ letter(): string

letter will generate a single random lower case ASCII letter

Returns: string

letterN

▸ letterN(n: number): string

letterN will generate a random ASCII string with length N

Parameters

Name Type Description
n number number of letters to generate

Returns: string

lexify

▸ lexify(str: string): string

lexify will replace ? with random generated letters

Parameters

Name Type
str string

Returns: string

logLevel

▸ logLevel(): string

logLevel will generate a random log level See data/LogLevels for list of available levels

Returns: string

longitude

▸ longitude(): number

longitude will generate a random longitude float64

Returns: number

longitudeInRange

▸ longitudeInRange(min: number, max: number): number

longitudeInRange will generate a random longitude within the input range

Parameters

Name Type
min number
max number

Returns: number

loremIpsumParagraph

▸ loremIpsumParagraph(paragraphCount: number, sentenceCount: number, wordCount: number, separator: string): string

loremIpsumParagraph will generate a random paragraphGenerator

Parameters

Name Type
paragraphCount number
sentenceCount number
wordCount number
separator string

Returns: string

loremIpsumSentence

▸ loremIpsumSentence(wordCount: number): string

loremIpsumSentence will generate a random sentence

Parameters

Name Type
wordCount number

Returns: string

loremIpsumWord

▸ loremIpsumWord(): string

loremIpsumWord will generate a random word

Returns: string

lunch

▸ lunch(): string

lunch will return a random lunch name

Returns: string

macAddress

▸ macAddress(): string

macAddress will generate a random mac address

Returns: string

minute

▸ minute(): number

minute will generate a random minute

Returns: number

month

▸ month(): number

month will generate a random month int

Returns: number

monthString

▸ monthString(): string

monthString will generate a random month string

Returns: string

name

▸ name(): string

name will generate a random First and Last Name

Returns: string

namePrefix

▸ namePrefix(): string

namePrefix will generate a random name prefix

Returns: string

nameSuffix

▸ nameSuffix(): string

nameSuffix will generate a random name suffix

Returns: string

nanoSecond

▸ nanoSecond(): number

nanoSecond will generate a random nano second

Returns: number

noun

▸ noun(): string

noun will generate a random noun

Returns: string

number

▸ number(min: number, max: number): number

number will generate a random number between given min And max

Parameters

Name Type
min number
max number

Returns: number

numerify

▸ numerify(str: string): string

numerify will replace # with random numerical values

Parameters

Name Type
str string

Returns: string

operaUserAgent

▸ operaUserAgent(): string

operaUserAgent will generate a random opera browser user agent string

Returns: string

paragraph

▸ paragraph(paragraphCount: number, sentenceCount: number, wordCount: number, separator: string): string

paragraph will generate a random paragraphGenerator

Parameters

Name Type
paragraphCount number
sentenceCount number
wordCount number
separator string

Returns: string

password

▸ password(lower: boolean, upper: boolean, numeric: boolean, special: boolean, num: number): string

password will generate a random password. Minimum number length of 5 if less than.

Parameters

Name Type
lower boolean
upper boolean
numeric boolean
special boolean
num number

Returns: string

person

▸ person(): string

person will generate a struct with person information

Returns: string

petName

▸ petName(): string

petName will return a random fun pet name

Returns: string

phone

▸ phone(): string

phone will generate a random phone number string

Returns: string

phoneFormatted

▸ phoneFormatted(): string

phoneFormatted will generate a random phone number string

Returns: string

phrase

▸ phrase(): string

phrase will return a random dictionary phrase

Returns: string

preposition

▸ preposition(): string

preposition will generate a random preposition

Returns: string

price

▸ price(min: number, max: number): number

price will take in a min and max value and return a formatted price

Parameters

Name Type
min number
max number

Returns: number

programmingLanguage

▸ programmingLanguage(): string

programmingLanguage will return a random programming language

Returns: string

programmingLanguageBest

▸ programmingLanguageBest(): string

programmingLanguageBest will return a random programming language

Returns: string

question

▸ question(): string

question will return a random question

Returns: string

quote

▸ quote(): string

quote will return a random quote from a random person

Returns: string

randomInt

▸ randomInt(all: number[]): number

randomInt will take in a slice of int and return a randomly selected value

Parameters

Name Type
all number[]

Returns: number

randomString

▸ randomString(all: string[]): string

randomString will take in a slice of string and return a randomly selected value

Parameters

Name Type
all string[]

Returns: string

randomUint

▸ randomUint(all: number[]): number

randomUint will take in a slice of uint and return a randomly selected value

Parameters

Name Type
all number[]

Returns: number

regex

▸ regex(regexStr: string): string

regex will generate a string based upon a RE2 syntax

Parameters

Name Type
regexStr string

Returns: string

rgbColor

▸ rgbColor(): number[]

rgbColor will generate a random int slice color

Returns: number[]

safariUserAgent

▸ safariUserAgent(): string

safariUserAgent will generate a random safari browser user agent string

Returns: string

safeColor

▸ safeColor(): string

safeColor will generate a random safe color string

Returns: string

second

▸ second(): number

second will generate a random second

Returns: number

sentence

▸ sentence(wordCount: number): string

sentence will generate a random sentence

Parameters

Name Type
wordCount number

Returns: string

snack

▸ snack(): string

snack will return a random snack name

Returns: string

ssn

▸ ssn(): string

SSN will generate a random Social Security Number

Returns: string

state

▸ state(): string

state will generate a random state string

Returns: string

stateAbr

▸ stateAbr(): string

stateAbr will generate a random abbreviated state string

Returns: string

street

▸ street(): string

street will generate a random address street string

Returns: string

streetName

▸ streetName(): string

streetName will generate a random address street name string

Returns: string

streetNumber

▸ streetNumber(): string

streetNumber will generate a random address street number string

Returns: string

streetPrefix

▸ streetPrefix(): string

streetPrefix will generate a random address street prefix string

Returns: string

streetSuffix

▸ streetSuffix(): string

streetSuffix will generate a random address street suffix string

Returns: string

timeZone

▸ timeZone(): string

timeZone will select a random timezone string

Returns: string

timeZoneAbv

▸ timeZoneAbv(): string

timeZoneAbv will select a random timezone abbreviation string

Returns: string

timeZoneFull

▸ timeZoneFull(): string

timeZoneFull will select a random full timezone string

Returns: string

timeZoneOffset

▸ timeZoneOffset(): number

timeZoneOffset will select a random timezone offset

Returns: number

timeZoneRegion

▸ timeZoneRegion(): string

timeZoneRegion will select a random region style timezone string, e.g. "America/Chicago"

Returns: string

uint16

▸ uint16(): number

uint16 will generate a random uint16 value

Returns: number

uint32

▸ uint32(): number

uint32 will generate a random uint32 value

Returns: number

uint64

▸ uint64(): number

uint64 will generate a random uint64 value

Returns: number

uint8

▸ uint8(): number

uint8 will generate a random uint8 value

Returns: number

url

▸ url(): string

url will generate a random url string

Returns: string

userAgent

▸ userAgent(): string

userAgent will generate a random broswer user agent

Returns: string

username

▸ username(): string

username will generate a random username based upon picking a random lastname and random numbers at the end

Returns: string

uuid

▸ uuid(): string

uuid (version 4) will generate a random unique identifier based upon random numbers Format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Returns: string

vegetable

▸ vegetable(): string

vegetable will return a random vegetable name

Returns: string

verb

▸ verb(): string

verb will generate a random verb

Returns: string

weekDay

▸ weekDay(): string

weekDay will generate a random weekday string (Monday-Sunday)

Returns: string

word

▸ word(): string

word will generate a random word

Returns: string

year

▸ year(): number

year will generate a random year between 1900 - current year

Returns: number

zip

▸ zip(): string

zip will generate a random Zip code string

Returns: string