fakerator
Advanced tools
Readme
Random fake data generator with localization
fakerator was inspired by and has used data definitions from Marak's faker.js library
If you like my work, please donate. Thank you!
$ bower install fakerator
$ npm install fakerator
Download the package and use the dist/fakerator.js or the dist/fakerator.min.js file in your project.
<script src="https://rawgit.com/icebob/fakerator/master/dist/fakerator.js"></script>
<script>
var fakerator = Fakerator();
var name = fakerator.names.name();
var user = fakerator.entity.user();
</script>
var Fakerator = require("fakerator");
var fakerator = Fakerator("de-DE");
var name = fakerator.names.name();
// Result: 'Dr. Marcus Drechsler'
Shortly
var fakerator = require("fakerator")("hu-HU");
var name = fakerator.names.name();
// Result: 'Fülöp Magdolna'
Or load a specific locale
var fakerator = require("fakerator/locales/de-DE")();
var name = fakerator.names.name();
// Result: 'Dr. Marcus Drechsler'
The library uses the Mersenne Twister pseudorandom number generator, so set seed value, if you want to get a repeatable random sequence:
fakerator.seed(5567832);
Generate random values or select a random element from array.
| Function | Description | Sample result |
|---|---|---|
fakerator.random.boolean() | Generate a boolean value | true |
fakerator.random.boolean(likelihoodPercent) | Generate a boolean value based a likelihood value. | false |
fakerator.random.number(max) | Generate a number value between 0 and max value | 87 |
fakerator.random.number(min, max) | Generate a number value between min and max | 54 |
fakerator.random.digit() | Generate a digit (0..9) | 5 |
fakerator.random.letter() | Generate a letter (a..z) | "h" |
fakerator.random.arrayElement(array) | Give a random element from the array | |
fakerator.random.objectElement(obj) | Give a random { key: value } from the object | |
fakerator.random.masked(mask) | Generate a masked string ( a - lowercase letter, A - uppercase letter, 9 - digit, * - letter or digit | "aaa-AAA_999:*" -> "aqa-RPG_932:6" |
fakerator.random.hex(length) | Generate a hexadecimal number | "7950a0b9" |
fakerator.random.string(length) | Generate a random string | "dulgecbhrsa" |
The library supports localizations. You can set the locale code in constructor.
// Use default (English) localization
var fakerator = Fakerator();
console.log(fakerator.names.name());
// Floyd Corkery
// Use german
var fakerator = Fakerator("de-DE");
console.log(fakerator.names.name());
// Hassan vom Kumbernuss
// Use russian
var fakerator = Fakerator("ru-RU");
console.log(fakerator.names.name());
// Альберт Валентинович Архипов
In production, you can load only a specific locale:
// Use french
var fakeratorFR = require("fakerator/locales/fr-FR")();
console.log(fakeratorFR.names.name());
// Dufour Camille
| Code | Language/Country | Usage | Creator/Source |
|---|---|---|---|
| default | English (default) | Fakerator(); | faker.js |
| cs-CZ | Czech | Fakerator("cs-CZ"); | zpiman |
| de-DE | German | Fakerator("de-DE"); | faker.js |
| en-AU | English (Australia) | Fakerator("en-AU"); | faker.js |
| en-CA | English (Canada) | Fakerator("en-CA"); | faker.js |
| es-ES | Spanish | Fakerator("es-ES"); | faker.js |
| fr-FR | French | Fakerator("fr-FR"); | faker.js |
| hu-HU | Hungarian | Fakerator("hu-HU"); | Icebob |
| it-IT | Italian | Fakerator("it-IT"); | faker.js |
| nb-NO | Norwegian | Fakerator("nb-NO"); | faker.js |
| pl-PL | Polish | Fakerator("pl-PL"); | faker.js |
| pt-BR | Brazilian Portuguese | Fakerator("pt-BR"); | Filipe Forattini |
| ru-RU | Russian | Fakerator("ru-RU"); | faker.js |
| sk-SK | Slovakian | Fakerator("sk-SK"); | faker.js |
| sv-SE | Swedish | Fakerator("sv-SE"); | faker.js |
Please read this how to add a new locale
Use this functions to generate fake random data
| Function | Description | Sample result |
|---|---|---|
fakerator.names.name() | Generate a full name | "Dr. Sheryl Gleichner" |
fakerator.names.nameM() | Generate a male full name (*) | "Bruce Weber" |
fakerator.names.nameF() | Generate a female full name (*) | "Juanita Daniel" |
fakerator.names.firstName() | Generate a first name | "Marco" |
fakerator.names.firstNameM() | Generate a male first name (*) | "Bruce" |
fakerator.names.firstNameF() | Generate a female first name (*) | "Kelly" |
fakerator.names.lastName() | Generate a last name | "Reilly" |
fakerator.names.lastNameM() | Generate a male last name (*) | "Collier" |
fakerator.names.lastNameF() | Generate a female last name (*) | "Moore" |
fakerator.names.prefix() | Generate a name prefix name | "Mr." |
fakerator.names.suffix() | Generate a name suffix | "MD" |
| (*) - if localization support |
| Function | Description | Sample result |
|---|---|---|
fakerator.address.country() | Give a country name | "Romania" |
fakerator.address.countryCode() | Give a country code | "RO" |
fakerator.address.countryAndCode() | Give a country object | { code: "RO", name: "Romania" } |
fakerator.address.city() | Generate a city name | "Merlestad" |
fakerator.address.street() | Generate a street address | "96214 Annette Radial Apt. 543" |
fakerator.address.streetName() | Generate a street name | "Gabriel Islands" |
fakerator.address.buildingNumber() | Generate a building number | "196" |
fakerator.address.postCode() | Generate a post code | "54360-6405" |
fakerator.address.geoLocation() | Generate a geolocation | { latitude: 40.4233, longitude: -131.9741 } |
fakerator.address.altitude() | Generate an altitude | 1180 |
| Function | Description | Sample result |
|---|---|---|
fakerator.phone.number() | Generate a phone number | "(640) 552-0763" |
| Function | Description | Sample result |
|---|---|---|
fakerator.company.name() | Generate a company name | "Weber, Gleichner and Kertzmann Inc." |
fakerator.company.suffix() | Generate a company suffix | "LLC" |
| Function | Description | Sample result |
|---|---|---|
fakerator.internet.userName() | Generate a username | "kelly.moore14" |
fakerator.internet.userName(firstName, lastName) | Generate a username based an existing name | "johndoe19" |
fakerator.internet.password(length) | Generate a password | |
fakerator.internet.domain() | Generate a domain name | "merle-gleichner.net" |
fakerator.internet.url() | Generate an url | "http://ella-parisian.com" |
fakerator.internet.email() | Generate an email address | "kelly.moore@gmail.com" |
fakerator.internet.email(firstName, lastName) | Generate an email address from an existing name | "john.doe@hotmail.com" |
fakerator.internet.image(width, height, category) | Generate a lorem image | "http://lorempixel.com/640/480" |
fakerator.internet.mac() | Generate a MAC address | "65:a1:a6:18:94:0b" |
fakerator.internet.ip() | Generate an IP v4 address | "69.45.112.94" |
fakerator.internet.ipv6() | Generate an IP v6 address | "b2e9:4275:95a9:65a1:a618:940b:a6ce:adb6" |
fakerator.internet.color() | Generate a color | "b76f49" |
fakerator.internet.avatar() | Give an avatar link (uifaces.com) | Sample |
fakerator.internet.gravatar() | Generate a gravatar link | Sample |
fakerator.internet.gravatar(email) | Generate a gravatar link from an email address | Sample |
| Function | Description | Sample result |
|---|---|---|
fakerator.lorem.word() | Give a lorem word | "dolores" |
fakerator.lorem.sentence() | Generate a lorem sentence | "Libero similique quam voluptas soluta." |
fakerator.lorem.paragraph() | Give a lorem paragraph | "Ut velit enim vel. Unde aut sint possimus velit commodi numquam. Autem expedita dignissimos est qui consequatur et delectus. Et qui necessitatibus voluptas quam. Dicta temporibus animi optio tempora aperiam repudiandae beatae. Placeat quo voluptatibus neque repellendus dolorem." |
| Function | Description | Sample result |
|---|---|---|
fakerator.date.timezone() | Give a timezone | "Asia/Bangkok" |
fakerator.date.past(years, refDate) | Generate a date in the past | Date |
fakerator.date.future(years, refDate) | Generate a date in the future | Date |
fakerator.date.between(from, to) | Generate a date between two dates | Date |
fakerator.date.recent(days) | Generate a date in recent few days | Date |
fakerator.date.age(min, max) | Generate an age number | 26 |
fakerator.date.month() | Give a month name | "September" |
fakerator.date.weekday() | Give a weekday name | "Sunday" |
fakerator.date.weekdayShort() | Give a short weekday name | "Fri" |
fakerator.date.weekdayMin() | Give a min weekday name | "Su" |
| Function | Description | Sample result |
|---|---|---|
fakerator.misc.uuid() | Generate an UUID | "e26717ad-1513-43c5-b7de-2849521fa195" |
You can generate complex entities
fakerator.entity.user()
Result:
{
"firstName": "Ashley",
"lastName": "Kautzer",
"userName": "ashley38",
"password": "yuzasimima",
"email": "ashleykautzer74@hotmail.com",
"phone": "1-485-841-6009",
"dob": "1939-11-22T01:15:16.735Z",
"website": "http://natalie-walker.info",
"ip": "202.26.104.4",
"avatar": "https://s3.amazonaws.com/uifaces/faces/twitter/jakemoore/128.jpg",
"gravatar": "https://www.gravatar.com/avatar/7875d665c96e5e388aa4074697cab0a0",
"address": {
"country": "Northern Mariana Islands",
"countryCode": "MP",
"state": "Michigan",
"city": "New Jamie",
"street": "1730 Abbott Views Apt. 460",
"zip": "77988",
"geo": {
"latitude": -41.5878,
"longitude": 34.266400000000004
}
},
"status": false
}
You can set genre of user with first parameter.
// F - female, M - male
fakerator.entity.user("F");
fakerator.entity.address()
Result:
{
"country": "Bulgaria",
"countryCode": "BG",
"state": "Indiana",
"city": "North Michele",
"street": "06169 Beer Villages Suite 302",
"zip": "20896",
"geo": {
"latitude": -9.275499999999994,
"longitude": 92.53280000000001
}
}
fakerator.entity.company()
Result:
{
"name": "Cormier, Murphy and Turcotte Ltd.",
"email": "cormier-murphy-and-turcotte-ltd.90@hotmail.com",
"phone": "044.708.8876 x834",
"website": "https://olgabeatty.info",
"ip": "54.65.201.35",
"address": {
"country": "Caribbean Netherlands",
"countryCode": "BQ",
"state": "Kansas",
"city": "East Ronnie",
"street": "81019 Cormier Mall",
"zip": "11474-0882",
"geo": {
"latitude": 1.6444000000000045,
"longitude": 107.97910000000002
}
}
}
fakerator.entity.post()
Result:
{
"title": "Esse excepturi eum id ab aut dolore veritatis et.",
"keywords": [
"commodi",
"odio",
"sit"
],
"created": "2016-05-25T18:19:46.283Z",
"content": "Mollitia officiis quam nulla veritatis omnis eius enim quis. Dolorem est reiciendis adipisci. Laboriosam enim saepe sunt nisi. Autem tempora ullam non laborum. Qui dolorem fugiat amet. Eius consectetur ea et minus ipsam et qui unde doloremque.\r\nNihil minima aut. Voluptatibus neque at nulla ut expedita laboriosam. Veniam natus voluptates nulla voluptas impedit cumque qui nihil.\r\nMinus quos in autem facere dolorem quidem rem rerum. Animi quo eaque debitis nam non earum molestiae. Maxime vitae exercitationem doloremque."
}
You can generate array of items with times and utimes (unique) functions.
First parameter is the generator function. Second is the length of array.
You can pass further parameters, they will be passed to the generator function.
// Generate 3 names
fakerator.times(fakerator.names.name, 3);
// [ "Ross Hansen", "Thomas Pfeffer", "Alexis Hauck I" ]
// Generate 5 username with populate where first name must be 'John'
fakerator.times(fakerator.populate, 5, "#{internet.userName}", "John");
// [ 'john.langosh8341', 'john12', 'john.howe5075', 'john_jerde', 'john.grant9923' ]
// Generate 5 number from 1 to 10
fakerator.times(fakerator.random.number, 5, 1, 10);
// [ 10, 8, 1, 8, 5 ]
// Note: 8 is twice!
// Generator 5 UNIQUE number from 1 to 10
fakerator.utimes(fakerator.random.number, 5, 1, 10);
// [ 10, 2, 9, 6, 1 ]
// Note: every number is unique!
You can also generate fake data with templates:
fakerator.populate("#{names.name}")
// Ross Hansen
fakerator.populate("#{address.street}")
// 0662 Ferry Drive
fakerator.populate("Hi, my name is #{names.name}. I was born in #{address.city}, #{address.country}. I am #{date.age} years old.")
// Hi, my name is Mrs. Rufus Shanahan. I was born in Hilpertton, Denmark. I am 44 years old.
The populate replace # symbol to a random number and ? symbol to a random letter.
fakerator.populate("#{names.firstName}-###-???")
// Mandy-802-oqs
Please send pull requests improving the usage and fixing bugs, improving documentation and providing better examples, or providing some testing, because these things are important.
fakerator is available under the MIT license.
Copyright (C) 2021 Icebob
FAQs
Random data generator with localization
The npm package fakerator receives a total of 12,055 weekly downloads. As such, fakerator popularity was classified as popular.
We found that fakerator demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.