faker-es6 - Massive realistic fake data generation tool for ES6+ projects, fully tree-shakable for a smaller package size

A heavily inspired lib to generate massive amounts of realistic fake data.

This lib was inspired by what I would like to see in Marak/faker.js plus what I thought that could be a good exercise for myself.

Table of contents

• Installation
• Getting started
  • First name example
  • First name with locale example
  • Importing the whole lib example
• Available methods
• Upcoming methods
• Localization
  • Localization example with TypeScript
  • Localization example without TypeScript
  • ISO Language Code Table
• Maintainer
• Credits
• License

Installation

Install faker-es6

yarn add --dev faker-es6

or

npm install --dev faker-es6

Getting started

First name example

import { firstName } from 'faker-es6/lib/name/firstName';
 
const name = firstName(); // Random first name: Yessenia
const anotherName = firstName(); // Random first name: Marilyne

First name with locale example

import { firstName } from 'faker-es6/lib/name/firstName';
import { Locale } from 'faker-es6/lib/types/locale';
 
const name = firstName(Locale.PT_BR); // Random first name in pt_BR: Bruna
const anotherName = firstName(Locale.PT_BR); // Random first name in pt_BR: Paula

Importing the whole lib example

import faker from 'faker-es6';
 
const name = faker.name.firstName(); // Random first name: Yessenia
const anotherName = faker.name.firstName(); // Random first name: Marilyne

Available methods

• name
  • firstName
  • lastName
  • prefix
  • suffix
• helpers
  • getLocale
  • randomArrayElement
  • randomArrayElements
  • randomNumber
  • parseRegex

Upcoming methods

• address
  • city
  • cityPrefix
  • citySuffix
  • country
  • countryCode
  • county
  • latitude
  • longitude
  • secondaryAddress
  • state
  • stateAbbreviation
  • streetAddress
  • streetName
  • streetPrefix
  • streetSuffix
  • zipCode
• commerce
  • color
  • department
  • price
  • productAdjective
  • productMaterial
  • productName
• company
  • catchPhrase
  • catchPhraseAdjective
  • catchPhraseDescriptor
  • catchPhraseNoun
  • companyName
  • companySuffix
  • jobArea
  • jobDescriptor
  • jobTitle
  • jobType
• date
  • between
  • future
  • month
  • past
  • recent
  • soon
  • weekday
• database
  • collation
  • column
  • engine
  • type
• finance
  • account
  • accountName
  • amount
  • bic
  • bitcoinAddress
  • currencyCode
  • currencyName
  • currencySymbol
  • ethereumAddress
  • iban
  • mask
  • transactionType
• hacker
  • abbreviation
  • adjective
  • ingverb
  • noun
  • phrase
  • verb
• helpers
  • shuffle
  • slugify
• internet
  • avatar
  • color
  • domainName
  • domainSuffix
  • domainWord
  • email
  • ip
  • ipv6
  • mac
  • password
  • protocol
  • url
  • userAgent
  • userName
• lorem
  • lines
  • paragraph
  • paragraphs
  • sentence
  • sentences
  • slug
  • text
  • word
  • words
  • homer
  • mussum (available only in pt_BR)
  • ronSwanson
  • theOffice
• name
  • title
• phone
  • phoneFormats
  • phoneNumber
  • phoneNumberFormat
• system
  • commonFileExt
  • commonFileName
  • commonFileType
  • directoryPath
  • fileExt
  • fileName
  • filePath
  • fileType
  • mimeType
  • semver

Localization

faker-es6 supports any ISO valid locale.

To use a locale, just pass it as a parameter in the method you want to use.

Current available locales

Since this is lib is a WIP, at the time of development it only supports:

• en 🇺🇸
• ja 🇯🇵 (partial support for now)
• pt_BR 🇧🇷

Localization example with TypeScript

import { firstName } from 'faker-es6/lib/name/firstName';
import { Locale } from 'faker-es6/lib/types/locale';
 
const name = firstName(Locale.PT_BR); // Random first name in pt_BR: Bruna
const anotherName = firstName(Locale.PT_BR); // Random first name in pt_BR: Paula

Locale is an TS enum object with all valid ISO language codes

Localization example without TypeScript

import { firstName } from 'faker-es6/lib/name/firstName';
 
const name = firstName('pt_BR'); // Random first name in pt_BR: Bruna
const anotherName = firstName('pt_BR'); // Random first name in pt_BR: Paula

For further information on the available language codes, see ISO Language Code Table section

ISO Language Code Table

Credits to http://www.lingoes.net/en/translator/langcode.htm

Maintainer

Samir J M Araujo

faker-es6 - Copyright (c) 2020 Samir J M Araujo - https://github.com/samir-araujo

If you ever think about copying, distributing, changing or anything related, please DO.

It would be awesome to see other people participating in this project in any possible ways.

All I ask is to leave some credit back to this repository 😁

Credits

This lib was inspired mostly by how I wanted to use Marak/faker.js, but I also have to thanks a lot these guys:

• https://github.com/Marak/faker.js
• http://www.lingoes.net/en/translator/langcode.htm
• https://github.com/ran81/homer-ipsum
• https://github.com/yoscheherazade/the-office-quotes-json
• https://github.com/erabug/simpsons-quotes
• https://github.com/jamesseanwright/ron-swanson-quotes

License

MIT License

Copyright (c) 2020 Samir J M Araujo samir.blanc@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.