Index

Modules: faker, faker/base, faker/provider/address, faker/provider/address/address_en_US, faker/provider/address/address_fa_IR, faker/provider/address/address_ja_JP, faker/provider/automotive, faker/provider/automotive/automotive_en_US, faker/provider/bank, faker/provider/bank/bank_en_US, faker/provider/company, faker/provider/company/company_en_US, faker/provider/company/company_ja_JP, faker/provider/currency, faker/provider/currency/currency_en_US, faker/provider/file, faker/provider/file/file_en_US, faker/provider/internet, faker/provider/internet/internet_en_US, faker/provider/internet/internet_fa_IR, faker/provider/internet/internet_ja_JP, faker/provider/isbn, faker/provider/isbn/isbn_en_US, faker/provider/job, faker/provider/job/job_en_US, faker/provider/job/job_fa_IR, faker/provider/job/job_ja_JP, faker/provider/lorem, faker/provider/lorem/lorem_en_US, faker/provider/lorem/lorem_fa_IR, faker/provider/lorem/lorem_ja_JP, faker/provider/misc, faker/provider/misc/misc_en_US, faker/provider/person, faker/provider/person/person_en_US, faker/provider/person/person_fa_IR, faker/provider/person/person_ja_JP, faker/provider/phone_number, faker/provider/phone_number/phone_number_en_US, faker/provider/phone_number/phone_number_fa_IR, faker/provider/phone_number/phone_number_ja_JP, faker/provider/ssn, faker/provider/ssn/ssn_en_US, faker/provider/user_agent, faker/provider/user_agent/user_agent_en_US, faker/provider/util.

API symbols

address:

• address: address(f: Faker): string
• address_en_US: address(f: Faker): string
• address_fa_IR: address(f: Faker): string
• address_ja_JP: address(f: Faker): string

androidPlatformToken:

• user_agent: androidPlatformToken(f: Faker): string
• user_agent_en_US: androidPlatformToken(f: Faker): string

asciiLowerCase:

• util: asciiLowerCase

asciiUpperCase:

• util: asciiUpperCase

ban:

• address_ja_JP: ban(f: Faker): string

bankCountry:

• bank: bankCountry(f: Faker): string
• bank_en_US: bankCountry(f: Faker): string

bban:

• bank: bban(f: Faker): string
• bank_en_US: bban(f: Faker): string

binary:

• misc: binary(f: Faker; length = 1048576): seq[byte]
• misc_en_US: binary(f: Faker; length = 1048576): seq[byte]

boolean:

• misc: boolean(f: Faker; chanceOfGettingTrue = 50): bool
• misc_en_US: boolean(f: Faker; chanceOfGettingTrue = 50): bool

bs:

• company: bs(f: Faker): string
• company_en_US: bs(f: Faker): string
• company_ja_JP: bs(f: Faker): string

buildingName:

• address_ja_JP: buildingName(f: Faker): string

buildingNumber:

• address: buildingNumber(f: Faker): string
• address_en_US: buildingNumber(f: Faker): string
• address_fa_IR: buildingNumber(f: Faker): string
• address_ja_JP: buildingNumber(f: Faker): string

catchPhrase:

• company: catchPhrase(f: Faker): string
• company_en_US: catchPhrase(f: Faker): string
• company_ja_JP: catchPhrase(f: Faker): string

chome:

• address_ja_JP: chome(f: Faker): string

chrome:

• user_agent: chrome(f: Faker): string
• user_agent_en_US: chrome(f: Faker): string

city:

• address: city(f: Faker): string
• address_en_US: city(f: Faker): string
• address_fa_IR: city(f: Faker): string
• address_ja_JP: city(f: Faker): string

cityPrefix:

• address: cityPrefix(f: Faker): string
• address_en_US: cityPrefix(f: Faker): string
• address_fa_IR: cityPrefix(f: Faker): string
• address_ja_JP: cityPrefix(f: Faker): string

citySuffix:

• address: citySuffix(f: Faker): string
• address_en_US: citySuffix(f: Faker): string
• address_fa_IR: citySuffix(f: Faker): string
• address_ja_JP: citySuffix(f: Faker): string

company:

• company: company(f: Faker): string
• company_en_US: company(f: Faker): string
• company_ja_JP: company(f: Faker): string

companyCategory:

• company_ja_JP: companyCategory(f: Faker): string

companyPrefix:

• company_ja_JP: companyPrefix(f: Faker): string

companySuffix:

• company: companySuffix(f: Faker): string
• company_en_US: companySuffix(f: Faker): string
• company_ja_JP: companySuffix(f: Faker): string

country:

• address: country(f: Faker): string

Country:

• address_en_US: Country

country:

• address_en_US: country(f: Faker): string
• address_fa_IR: country(f: Faker): string
• address_ja_JP: country(f: Faker): string

countryCode:

• address_en_US: countryCode(f: Faker; representation: string): string
• address_fa_IR: countryCode(f: Faker; representation: string): string
• address_ja_JP: countryCode(f: Faker; representation: string): string

countryCodes:

• address_ja_JP: countryCodes

cryptocurrency:

• currency: cryptocurrency(f: Faker): (string, string)
• currency_en_US: cryptocurrency(f: Faker): (string, string)

cryptocurrencyCode:

• currency: cryptocurrencyCode(f: Faker): string
• currency_en_US: cryptocurrencyCode(f: Faker): string

cryptocurrencyName:

• currency: cryptocurrencyName(f: Faker): string
• currency_en_US: cryptocurrencyName(f: Faker): string

currency:

• currency: currency(f: Faker): (string, string)
• currency_en_US: currency(f: Faker): (string, string)

currencyCode:

• currency: currencyCode(f: Faker): string
• currency_en_US: currencyCode(f: Faker): string

currencyName:

• currency: currencyName(f: Faker): string
• currency_en_US: currencyName(f: Faker): string

currencySymbol:

• currency: currencySymbol(f: Faker): string
• currency_en_US: currencySymbol(f: Faker): string

email:

• internet: email(f: Faker): string
• internet_en_US: email(f: Faker): string
• internet_fa_IR: email(f: Faker): string
• internet_ja_JP: email(f: Faker): string

Faker:

• base: Faker

fileExtension:

• file: fileExtension(f: Faker; category = ""): string
• file_en_US: fileExtension(f: Faker; category = ""): string

fileName:

• file: fileName(f: Faker; category = ""; extension = ""): string
• file_en_US: fileName(f: Faker; category = ""; extension = ""): string

filePath:

• file: filePath(f: Faker; depth = 1; category = ""; extension = ""): string
• file_en_US: filePath(f: Faker; depth = 1; category = ""; extension = ""): string

finglish:

• person_fa_IR: finglish

firefox:

• user_agent: firefox(f: Faker): string
• user_agent_en_US: firefox(f: Faker): string

firstKanaName:

• person_ja_JP: firstKanaName(f: Faker): string

firstKanaNameFemale:

• person_ja_JP: firstKanaNameFemale(f: Faker): string

firstKanaNameMale:

• person_ja_JP: firstKanaNameMale(f: Faker): string

firstName:

• person: firstName(f: Faker): string
• person_en_US: firstName(f: Faker): string
• person_fa_IR: firstName(f: Faker): string
• person_ja_JP: firstName(f: Faker): string

firstNameFemale:

• person: firstNameFemale(f: Faker): string
• person_en_US: firstNameFemale(f: Faker): string
• person_fa_IR: firstNameFemale(f: Faker): string
• person_ja_JP: firstNameFemale(f: Faker): string

firstNameMale:

• person: firstNameMale(f: Faker): string
• person_en_US: firstNameMale(f: Faker): string
• person_fa_IR: firstNameMale(f: Faker): string
• person_ja_JP: firstNameMale(f: Faker): string

firstRomanizedName:

• person_ja_JP: firstRomanizedName(f: Faker): string

firstRomanizedNameFemale:

• person_ja_JP: firstRomanizedNameFemale(f: Faker): string

firstRomanizedNameMale:

• person_ja_JP: firstRomanizedNameMale(f: Faker): string

floorNumber:

• address_fa_IR: floorNumber(f: Faker): string

formatNumbers:

• util: formatNumbers(r: var Rand; format: string): string

formatUpperAscii:

• util: formatUpperAscii(r: var Rand; format: string): string

freeDomainName:

• internet: freeDomainName(f: Faker): string
• internet_en_US: freeDomainName(f: Faker): string
• internet_fa_IR: freeDomainName(f: Faker): string
• internet_ja_JP: freeDomainName(f: Faker): string

freeEmail:

• internet: freeEmail(f: Faker): string
• internet_en_US: freeEmail(f: Faker): string
• internet_fa_IR: freeEmail(f: Faker): string
• internet_ja_JP: freeEmail(f: Faker): string

gou:

• address_ja_JP: gou(f: Faker): string

iban:

• bank: iban(f: Faker): string
• bank_en_US: iban(f: Faker): string

internetExplorer:

• user_agent: internetExplorer(f: Faker): string
• user_agent_en_US: internetExplorer(f: Faker): string

iosPlatformToken:

• user_agent: iosPlatformToken(f: Faker): string
• user_agent_en_US: iosPlatformToken(f: Faker): string

isbn10:

• isbn: isbn10(f: Faker; separator = ""): string
• isbn_en_US: isbn10(f: Faker; separator = ""): string

isbn13:

• isbn: isbn13(f: Faker; separator = ""): string
• isbn_en_US: isbn13(f: Faker; separator = ""): string

job:

• job: job(f: Faker): string
• job_en_US: job(f: Faker): string
• job_fa_IR: job(f: Faker): string
• job_ja_JP: job(f: Faker): string

kanaName:

• person_ja_JP: kanaName(f: Faker): string

lastKanaName:

• person_ja_JP: lastKanaName(f: Faker): string

lastName:

• person: lastName(f: Faker): string
• person_en_US: lastName(f: Faker): string
• person_fa_IR: lastName(f: Faker): string
• person_ja_JP: lastName(f: Faker): string

lastNameFemale:

• person: lastNameFemale(f: Faker): string
• person_en_US: lastNameFemale(f: Faker): string
• person_fa_IR: lastNameFemale(f: Faker): string
• person_ja_JP: lastNameFemale(f: Faker): string

lastNameMale:

• person: lastNameMale(f: Faker): string
• person_en_US: lastNameMale(f: Faker): string
• person_fa_IR: lastNameMale(f: Faker): string
• person_ja_JP: lastNameMale(f: Faker): string

lastRomanizedName:

• person_ja_JP: lastRomanizedName(f: Faker): string

licensePlate:

• automotive: licensePlate(f: Faker): string
• automotive_en_US: licensePlate(f: Faker): string

linuxPlatformToken:

• user_agent: linuxPlatformToken(f: Faker): string
• user_agent_en_US: linuxPlatformToken(f: Faker): string

linuxProcessor:

• user_agent: linuxProcessor(f: Faker): string
• user_agent_en_US: linuxProcessor(f: Faker): string

macPlatformToken:

• user_agent: macPlatformToken(f: Faker): string
• user_agent_en_US: macPlatformToken(f: Faker): string

macProcessor:

• user_agent: macProcessor(f: Faker): string
• user_agent_en_US: macProcessor(f: Faker): string

md5:

• misc: md5(f: Faker): string
• misc_en_US: md5(f: Faker): string

militaryApo:

• address: militaryApo(f: Faker): string
• address_en_US: militaryApo(f: Faker): string
• address_fa_IR: militaryApo(f: Faker): string
• address_ja_JP: militaryApo(f: Faker): string

militaryDpo:

• address: militaryDpo(f: Faker): string
• address_en_US: militaryDpo(f: Faker): string
• address_fa_IR: militaryDpo(f: Faker): string
• address_ja_JP: militaryDpo(f: Faker): string

militaryShip:

• address: militaryShip(f: Faker): string
• address_en_US: militaryShip(f: Faker): string
• address_fa_IR: militaryShip(f: Faker): string
• address_ja_JP: militaryShip(f: Faker): string

militaryState:

• address: militaryState(f: Faker): string
• address_en_US: militaryState(f: Faker): string
• address_fa_IR: militaryState(f: Faker): string
• address_ja_JP: militaryState(f: Faker): string

mimeType:

• file: mimeType(f: Faker; category = ""): string
• file_en_US: mimeType(f: Faker; category = ""): string

msisdn:

• phone_number: msisdn(f: Faker): string
• phone_number_en_US: msisdn(f: Faker): string
• phone_number_fa_IR: msisdn(f: Faker): string
• phone_number_ja_JP: msisdn(f: Faker): string

name:

• person: name(f: Faker): string
• person_en_US: name(f: Faker): string
• person_fa_IR: name(f: Faker): string
• person_ja_JP: name(f: Faker): string

nameFemale:

• person: nameFemale(f: Faker): string
• person_en_US: nameFemale(f: Faker): string
• person_fa_IR: nameFemale(f: Faker): string
• person_ja_JP: nameFemale(f: Faker): string

nameMale:

• person: nameMale(f: Faker): string
• person_en_US: nameMale(f: Faker): string
• person_fa_IR: nameMale(f: Faker): string
• person_ja_JP: nameMale(f: Faker): string

newFaker:

• base: newFaker(locale = ""; seed = 0): Faker

opera:

• user_agent: opera(f: Faker): string
• user_agent_en_US: opera(f: Faker): string

phoneNumber:

• phone_number: phoneNumber(f: Faker): string
• phone_number_en_US: phoneNumber(f: Faker): string
• phone_number_fa_IR: phoneNumber(f: Faker): string
• phone_number_ja_JP: phoneNumber(f: Faker): string

postalcode:

• address: postalcode(f: Faker): string
• address_en_US: postalcode(f: Faker): string
• address_fa_IR: postalcode(f: Faker): string
• address_ja_JP: postalcode(f: Faker): string

postalcodeInState:

• address_en_US: postalcodeInState(f: Faker; stateAbbr: string): string
• address_fa_IR: postalcodeInState(f: Faker; stateAbbr: string): string
• address_ja_JP: postalcodeInState(f: Faker; stateAbbr: string): string

postalcodePlus4:

• address: postalcodePlus4(f: Faker): string
• address_en_US: postalcodePlus4(f: Faker): string
• address_fa_IR: postalcodePlus4(f: Faker): string
• address_ja_JP: postalcodePlus4(f: Faker): string

postcode:

• address: postcode(f: Faker): string
• address_en_US: postcode(f: Faker): string
• address_fa_IR: postcode(f: Faker): string
• address_ja_JP: postcode(f: Faker): string

prefecture:

• address_fa_IR: prefecture(f: Faker): string
• address_ja_JP: prefecture(f: Faker): string

prefix:

• person: prefix(f: Faker): string
• person_en_US: prefix(f: Faker): string
• person_fa_IR: prefix(f: Faker): string
• person_ja_JP: prefix(f: Faker): string

prefixFemale:

• person: prefixFemale(f: Faker): string
• person_en_US: prefixFemale(f: Faker): string
• person_fa_IR: prefixFemale(f: Faker): string
• person_ja_JP: prefixFemale(f: Faker): string

prefixMale:

• person: prefixMale(f: Faker): string
• person_en_US: prefixMale(f: Faker): string
• person_fa_IR: prefixMale(f: Faker): string
• person_ja_JP: prefixMale(f: Faker): string

romanizedName:

• person_ja_JP: romanizedName(f: Faker): string

safari:

• user_agent: safari(f: Faker): string
• user_agent_en_US: safari(f: Faker): string

safeDomainName:

• internet: safeDomainName(f: Faker): string
• internet_en_US: safeDomainName(f: Faker): string
• internet_fa_IR: safeDomainName(f: Faker): string
• internet_ja_JP: safeDomainName(f: Faker): string

safeEmail:

• internet: safeEmail(f: Faker): string
• internet_en_US: safeEmail(f: Faker): string
• internet_fa_IR: safeEmail(f: Faker): string
• internet_ja_JP: safeEmail(f: Faker): string

secondaryAddress:

• address: secondaryAddress(f: Faker): string
• address_en_US: secondaryAddress(f: Faker): string
• address_fa_IR: secondaryAddress(f: Faker): string
• address_ja_JP: secondaryAddress(f: Faker): string

sha1:

• misc: sha1(f: Faker): string
• misc_en_US: sha1(f: Faker): string

ssn:

• ssn: ssn(f: Faker): string
• ssn_en_US: ssn(f: Faker): string

state:

• address: state(f: Faker): string
• address_en_US: state(f: Faker): string
• address_fa_IR: state(f: Faker): string
• address_ja_JP: state(f: Faker): string

stateAbbr:

• address_en_US: stateAbbr(f: Faker; includeTerritories: bool): string
• address_fa_IR: stateAbbr(f: Faker; includeTerritories: bool): string
• address_ja_JP: stateAbbr(f: Faker; includeTerritories: bool): string

streetAddress:

• address: streetAddress(f: Faker): string
• address_en_US: streetAddress(f: Faker): string
• address_fa_IR: streetAddress(f: Faker): string
• address_ja_JP: streetAddress(f: Faker): string

streetName:

• address: streetName(f: Faker): string
• address_en_US: streetName(f: Faker): string
• address_fa_IR: streetName(f: Faker): string
• address_ja_JP: streetName(f: Faker): string

streetSuffix:

• address: streetSuffix(f: Faker): string
• address_en_US: streetSuffix(f: Faker): string
• address_fa_IR: streetSuffix(f: Faker): string
• address_ja_JP: streetSuffix(f: Faker): string

suffix:

• person: suffix(f: Faker): string
• person_en_US: suffix(f: Faker): string
• person_fa_IR: suffix(f: Faker): string
• person_ja_JP: suffix(f: Faker): string

suffixFemale:

• person: suffixFemale(f: Faker): string
• person_en_US: suffixFemale(f: Faker): string
• person_fa_IR: suffixFemale(f: Faker): string
• person_ja_JP: suffixFemale(f: Faker): string

suffixMale:

• person: suffixMale(f: Faker): string
• person_en_US: suffixMale(f: Faker): string
• person_fa_IR: suffixMale(f: Faker): string
• person_ja_JP: suffixMale(f: Faker): string

topLevelDomain:

• internet: topLevelDomain(f: Faker): string
• internet_en_US: topLevelDomain(f: Faker): string
• internet_fa_IR: topLevelDomain(f: Faker): string
• internet_ja_JP: topLevelDomain(f: Faker): string

town:

• address_fa_IR: town(f: Faker): string
• address_ja_JP: town(f: Faker): string

unixDevice:

• file: unixDevice(f: Faker; prefix = ""): string
• file_en_US: unixDevice(f: Faker; prefix = ""): string

unixPartition:

• file: unixPartition(f: Faker; prefix = ""): string
• file_en_US: unixPartition(f: Faker; prefix = ""): string

userAgent:

• user_agent: userAgent(f: Faker): string
• user_agent_en_US: userAgent(f: Faker): string

windowsPlatformToken:

• user_agent: windowsPlatformToken(f: Faker): string
• user_agent_en_US: windowsPlatformToken(f: Faker): string

word:

• lorem: word(f: Faker): string
• lorem_en_US: word(f: Faker): string
• lorem_fa_IR: word(f: Faker): string
• lorem_ja_JP: word(f: Faker): string

zipcode:

• address: zipcode(f: Faker): string
• address_en_US: zipcode(f: Faker): string
• address_fa_IR: zipcode(f: Faker): string
• address_ja_JP: zipcode(f: Faker): string

zipcodeInState:

• address_en_US: zipcodeInState(f: Faker; stateAbbr: string): string
• address_fa_IR: zipcodeInState(f: Faker; stateAbbr: string): string
• address_ja_JP: zipcodeInState(f: Faker; stateAbbr: string): string

zipcodePlus4:

• address: zipcodePlus4(f: Faker): string
• address_en_US: zipcodePlus4(f: Faker): string
• address_fa_IR: zipcodePlus4(f: Faker): string
• address_ja_JP: zipcodePlus4(f: Faker): string