GitHub - withshepherd/faker.js
source link: https://github.com/withshepherd/faker.js
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
faker.js - generate massive amounts of fake data in the browser and node.js
FAQ - What happened to the original faker.js?
This project was originally created and hosted at https://github.com/marak/Faker.js/ - however around 4th Jan, 2022 - the author decided to delete the repository (for unknown reasons).
In the interest of the community, it has been decided that faker.js will continue to be maintained here and all help in its development will be appreciated
Coming Soon !
Faker Cloud
Coming Soon !
Usage
Browser
<script src="faker.js" type="text/javascript"></script> <script> var randomName = faker.name.findName(); // Caitlyn Kerluke var randomEmail = faker.internet.email(); // [email protected] var randomCard = faker.helpers.createCard(); // random contact card containing many properties </script>
Node.js
var faker = require("faker"); var randomName = faker.name.findName(); // Rowan Nikolaus var randomEmail = faker.internet.email(); // [email protected] var randomCard = faker.helpers.createCard(); // random contact card containing many properties
API Methods
- address
- zipCode
- zipCodeByState
- cityPrefix
- citySuffix
- cityName
- streetName
- streetAddress
- streetSuffix
- streetPrefix
- secondaryAddress
- county
- country
- countryCode
- state
- stateAbbr
- latitude
- longitude
- direction
- cardinalDirection
- ordinalDirection
- nearbyGPSCoordinate
- timeZone
- animal
- snake
- cetacean
- horse
- crocodilia
- insect
- rabbit
- commerce
- color
- department
- productName
- price
- productAdjective
- productMaterial
- product
- productDescription
- company
- suffixes
- companyName
- companySuffix
- catchPhrase
- catchPhraseAdjective
- catchPhraseDescriptor
- catchPhraseNoun
- bsAdjective
- bsBuzz
- bsNoun
- database
- column
- collation
- engine
- datatype
- number
- float
- datetime
- string
- boolean
- hexaDecimal
- array
- date
- future
- between
- betweens
- recent
- month
- weekday
- finance
- account
- accountName
- routingNumber
- amount
- transactionType
- currencyCode
- currencyName
- currencySymbol
- bitcoinAddress
- litecoinAddress
- creditCardNumber
- creditCardCVV
- ethereumAddress
- transactionDescription
- git
- branch
- commitEntry
- commitMessage
- commitSha
- shortSha
- hacker
- abbreviation
- adjective
- ingverb
- phrase
- helpers
- randomize
- slugify
- replaceSymbolWithNumber
- replaceSymbols
- replaceCreditCardSymbols
- repeatString
- regexpStyleStringParse
- shuffle
- mustache
- createCard
- contextualCard
- userCard
- createTransaction
- image
- image
- avatar
- imageUrl
- abstract
- animals
- business
- nightlife
- fashion
- people
- nature
- sports
- technics
- transport
- dataUri
- lorempixel
- unsplash
- lorempicsum
- internet
- avatar
- exampleEmail
- userName
- protocol
- httpMethod
- domainName
- domainSuffix
- domainWord
- userAgent
- color
- password
- lorem
- words
- sentence
- sentences
- paragraph
- paragraphs
- lines
- mersenne
- seed_array
- music
- genre
- name
- firstName
- lastName
- middleName
- findName
- jobTitle
- gender
- prefix
- suffix
- title
- jobDescriptor
- jobArea
- jobType
- phone
- phoneNumber
- phoneNumberFormat
- phoneFormats
- random
- number
- float
- arrayElement
- arrayElements
- objectElement
- boolean
- words
- image
- locale
- alpha
- alphaNumeric
- hexaDecimal
- system
- fileName
- commonFileName
- mimeType
- commonFileType
- commonFileExt
- fileType
- fileExt
- directoryPath
- filePath
- semver
- time
- recent
- unique
- vehicle
- vehicle
- manufacturer
- model
- color
- bicycle
Faker.fake()
faker.js contains a super useful generator method Faker.fake
for combining faker API methods using a mustache string format.
Example:
console.log( faker.fake("{{name.lastName}}, {{name.firstName}} {{name.suffix}}") ); // outputs: "Marks, Dean Sr."
This will interpolate the format string with the value of methods name.lastName()
, name.firstName()
, and name.suffix()
Localization
As of version v2.0.0
faker.js has support for multiple localities.
The default language locale is set to English.
Setting a new locale is simple:
// sets locale to de faker.locale = "de";
- de_AT
- de_CH
- en_AU
- en_AU_ocker
- en_BORK
- en_CA
- en_GB
- en_IE
- en_IND
- en_US
- en_ZA
- es_MX
- fr_CA
- fr_CH
- id_ID
- nb_NO
- nl_BE
- pt_BR
- pt_PT
- zh_CN
- zh_TW
Individual Localization Packages
faker.js supports incremental loading of locales.
By default, requiring faker
will include all locale data.
In a production environment, you may only want to include the locale data for a specific set of locales.
// loads only de locale var faker = require("faker/locale/de");
Setting a randomness seed
If you want consistent results, you can set your own seed:
faker.seed(123); var firstRandom = faker.datatype.number(); // Setting the seed again resets the sequence. faker.seed(123); var secondRandom = faker.datatype.number(); console.log(firstRandom === secondRandom);
Tests
npm install . make test
You can view a code coverage report generated in coverage/lcov-report/index.html.
Building faker.js
faker uses gulp to automate its build process. Each build operation is a separate task which can be run independently.
Browser Bundle
npm run browser
Building JSDocs
JSDOC v3 HTML API documentation
npm run jsdoc
Building ReadMe
The ReadMe.md
file for faker.js
is automatically generated and should not be modified directly. All updates to ReadMe.md
should be performed in ./build/src/docs.md
and then the build script should be run.
npm run readme
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK