1.0.0 • Published 4 years ago

@thangiswho/simple-faker v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago

simple-faker

simple-faker generates massive amount of json fake data with zero coding. Creating a fake REST API even simpler by combining simple-faker and json-server. simple-faker uses faker.js to generate fake data.

Getting started

Install simple-faker

# Using yarn
yarn add simple-faker
# Using npm
npm install simple-faker

Typescript Usage

import {SimpleFaker} from "simple-faker";

Javacript Usage

const {SimpleFaker} = require("simple-faker");
const faker = new SimpleFaker("en", 10);
faker.fake("integer"); // return 75
faker.fake("integer(10,99)"); // return 2 digits number
faker.fake("html"); // return html string block
faker.fakeSchema({
  "id": "integer",
  "username": "username(6,20)",
  "email": "email",
  "first_name": "name.firstName",
  "last_name": "name.lastName",
  "password": "password",
  "last_login": "datetime",
  "gender": "gender",
  "about": "Hello, my name is {{name.firstName}}. I was born in {{address.cityName}}.",
  "profile": "html(2,5)",
}); // return object with the same schema

faker.fakeApi({
  "User": {
    "id": "integer",
    "username": "username(5,30)",
    "email": "email",
    "last_login": "datetime"
  },
  "Post": {
    "id": "integer",
    "author": "username(5,30)",
    "content": "html(4,7)",
    "summary": "lorem.paragraphs(2,3)",
    "created_at": "datetime",
    "published": "boolean"
  },
});
/**
 * return json-server compatible mockup json
 * Data length of each data set is defined when initialize new SimpleFaker(locale, dataLength)
 * {
 *   "User": [
 *     {
 *       "id": ...
 *       "username": ...
 *       ...
 *     },
 *     {
 *       "id": ...
 *       "username": ...
 *       ...
 *     }
 *   ],
 *   "Post": [
 *     {
 *       "id": ...
 *       "author": ...
 *       ...
 *     },
 *     {
 *       "id": ...
 *       "author": ...
 *       ...
 *     }
 *   ],
 * ]

With the cli fake-data, you can simply create a fake REST API with json-server. schema.json file content is exactly as same as the schema passed to faker.fakeApi(schema)

yarn fake-data -o mockupdb.json schema.json
json-server --watch mockupdb.json

Usage

Basic Types

const faker = new SimpleFaker("en", 10); // The default locale is en, data length is 10
// const faker = new SimpleFaker();
// const faker = new SimpleFaker("ja", 20);
faker.setLocale("de"); // change locale after initialized
faker.setLength(15);  // change data length after initialized

const min = 10;
const max = 99;
faker.fakeInteger(min, max); // return 2 digits number
faker.fake("integer(10,99)"); // same as above
faker.fakeString(min, max); // return a string whose length between min and max.
faker.fake("string(10,99)"); // same as above

faker.fake("float(10,99)"); // same as faker.fakeFloat(10,99)
faker.fake("boolean"); // same as faker.fakeBoolean()
faker.fake("date"); // format yyyy-mm-dd
faker.fake("time"); // format h:i:s
faker.fake("datetime"); // format yyyy-mm-dd h:i:s
faker.fake("image"); // return a fake image url
faker.fake("name"); // return a fake full name
faker.fake("username(6,20)"); // return a fake alphanumeric string whose length is from 6 to 20 
faker.fake("html(2,4)"); // return a fake html paragraphs with number of paragraphs is between 2 to 4

faker.js Types

simple-faker supports all types from faker.js

Usage: faker.fake(${type}) or faker.fake(${group}.${type}). With some specific types which have one numeric argument, such as words, paragraphs, you can use the following api:

faker.fake(`typename(${min},${max})`)
faker.fake(`group.typename(${min},${max})`)

Basically, simple-faker try to find all grand-children properties of faker.js, it will call faker.js if there is any grand-child properties found

faker.fake("address.city"); // same as faker.js's faker.address.city()
// simple-faker is smart to find city is property of address
faker.fake("city"); // same as faker.js's faker.address.city()

faker.fake("lorem.words(2,5)"); // same as faker.js's faker.lorem.words(n) with 2 <= n <= 5
// simple-faker is smart to find words is property of lorem
faker.fake("words"); // same as faker.js's faker.lorem.words()

mustache Format Types

simple-faker also supports faker.js' mustache format. Further more, you can fake schema nested with other schema

faker.fakeSchema({
  message: "{{name.lastName}} {{name.firstName}} lives in {{address.country}}",
  money: "{{finance.amount}} millions USD",
  crypto: "finance.bitcoinAddress",
  nested: {
    prop1: "lorem.phrase",
    tags: ["word", "words(2,2)"],
    comments: [
      {commentId: "integer(1000,9999)", comment: "html(1,3)"},
      {commentId: "integer(100000,999999)", comment: "html(2,4)"}
    ]
  }
});

Nested Schema

simple-faker also supports schema nested by other schema.

faker.fakeApi({
  "User": userSchema,
  "Post": {
    "id": "integer",
    "ref": postSchema,
    "tags": ["word", "words(2,2)"],
    "comments": [commentSchema, commentSchema, commentSchema]
  }
});

Customized Types

You can easily add your own type, and then define it in your schema. All type name is case-insensitive.

const categories = [
  faker.fake("string(6, 10)"),
  faker.fake("name"),
  faker.fake("words(2,3)"),
];
faker.addType("MyTax", () => {
  return faker.fakeInteger(1000,5000) * 21 / 100;
});
faker.addType("MyCategory", () => {
  return categories[faker.fakeInteger(0, categories.length - 1)];
});
faker.fake("MyCategory");
faker.fakeApi({
  "News": {
    "id": "integer",
    "title": "lorem.phrase",
    "content": "html(5,8)",
    "category": "mycategory", // great, I can add my own customized type
  },
  "Salary": {
    "net": "integer(100000,120000)",
    "tax": "mytax"  // great, I can add my own customized type
  }
});

API Methods

.bin/fake-data command

# npx fake-data schema.json
yarn fake-data --help
fake-data [options] <schema json file>

Options:
      --help     Show help                                             [boolean]
      --version  Show version number                                   [boolean]
  -n, --length   The length of each generated data set             [default: 10]
  -l, --locale   The locale (eg. "ja", "de")                     [default: "en"]
  -o, --output   Write faked data to file                          [default: ""]

yarn fake-data schema.json
yarn fake-data -o mockupdb.json schema.json

Then, run a mockup jsons-server

json-server mockupdb.json

SimpleFaker class

  • fake: faker.fake(dataType) to fake a single data type
  • fakeSchema: faker.fakeSchema(objectType) to fake a whole object
  • fakeApi: faker.fakeApi(apiSchema) to run mockup json-server

SimpleFaker.fake(dataType) Types list

You can define your schema type with any type from the following types.

// schema.json
{
  "Api1": {
    "prop": "type",
    "prop": "type(min,max)"
  },
  "Api2": {
    "prop": "type",
    "prop": "group.type",
    "prop": "group.type(min,max)"
  }
}
  • integer
  • float
  • boolean
  • string
  • date
  • time
  • datetime
  • image
  • name
  • username

  • html

  • random.number

  • random.float
  • random.arrayElement
  • random.arrayElements
  • random.objectElement
  • random.uuid
  • random.boolean
  • random.word
  • random.words
  • random.image
  • random.locale
  • random.alpha
  • random.alphaNumeric
  • random.hexaDecimal
  • helpers.randomize
  • helpers.slugify
  • helpers.replaceSymbolWithNumber
  • helpers.replaceSymbols
  • helpers.replaceCreditCardSymbols
  • helpers.repeatString
  • helpers.regexpStyleStringParse
  • helpers.shuffle
  • helpers.mustache
  • helpers.createCard
  • helpers.contextualCard
  • helpers.userCard
  • helpers.createTransaction
  • name.firstName
  • name.lastName
  • name.middleName
  • name.findName
  • name.jobTitle
  • name.gender
  • name.prefix
  • name.suffix
  • name.title
  • name.jobDescriptor
  • name.jobArea
  • name.jobType
  • address.zipCode
  • address.zipCodeByState
  • address.city
  • address.cityPrefix
  • address.citySuffix
  • address.cityName
  • address.streetName
  • address.streetAddress
  • address.streetSuffix
  • address.streetPrefix
  • address.secondaryAddress
  • address.county
  • address.country
  • address.countryCode
  • address.state
  • address.stateAbbr
  • address.latitude
  • address.longitude
  • address.direction
  • address.cardinalDirection
  • address.ordinalDirection
  • address.nearbyGPSCoordinate
  • address.timeZone
  • animal.dog
  • animal.cat
  • animal.snake
  • animal.bear
  • animal.lion
  • animal.cetacean
  • animal.horse
  • animal.bird
  • animal.cow
  • animal.fish
  • animal.crocodilia
  • animal.insect
  • animal.rabbit
  • animal.type
  • company.suffixes
  • company.companyName
  • company.companySuffix
  • company.catchPhrase
  • company.bs
  • company.catchPhraseAdjective
  • company.catchPhraseDescriptor
  • company.catchPhraseNoun
  • company.bsAdjective
  • company.bsBuzz
  • company.bsNoun
  • finance.account
  • finance.accountName
  • finance.routingNumber
  • finance.mask
  • finance.amount
  • finance.transactionType
  • finance.currencyCode
  • finance.currencyName
  • finance.currencySymbol
  • finance.bitcoinAddress
  • finance.litecoinAddress
  • finance.creditCardNumber
  • finance.creditCardCVV
  • finance.ethereumAddress
  • finance.iban
  • finance.bic
  • finance.transactionDescription
  • image.image
  • image.avatar
  • image.imageUrl
  • image.abstract
  • image.animals
  • image.business
  • image.cats
  • image.city
  • image.food
  • image.nightlife
  • image.fashion
  • image.people
  • image.nature
  • image.sports
  • image.technics
  • image.transport
  • image.dataUri
  • lorem.word
  • lorem.words
  • lorem.sentence
  • lorem.slug
  • lorem.sentences
  • lorem.paragraph
  • lorem.paragraphs
  • lorem.text
  • lorem.lines
  • hacker.abbreviation
  • hacker.adjective
  • hacker.noun
  • hacker.verb
  • hacker.ingverb
  • hacker.phrase
  • internet.avatar
  • internet.email
  • internet.exampleEmail
  • internet.userName
  • internet.protocol
  • internet.httpMethod
  • internet.url
  • internet.domainName
  • internet.domainSuffix
  • internet.domainWord
  • internet.ip
  • internet.ipv6
  • internet.port
  • internet.userAgent
  • internet.color
  • internet.mac
  • internet.password
  • database.column
  • database.type
  • database.collation
  • database.engine
  • phone.phoneNumber
  • phone.phoneNumberFormat
  • phone.phoneFormats
  • date.past
  • date.future
  • date.between
  • date.betweens
  • date.recent
  • date.soon
  • date.month
  • date.weekday
  • time.recent
  • commerce.color
  • commerce.department
  • commerce.productName
  • commerce.price
  • commerce.productAdjective
  • commerce.productMaterial
  • commerce.product
  • commerce.productDescription
  • system.fileName
  • system.commonFileName
  • system.mimeType
  • system.commonFileType
  • system.commonFileExt
  • system.fileType
  • system.fileExt
  • system.directoryPath
  • system.filePath
  • system.semver
  • git.branch
  • git.commitEntry
  • git.commitMessage
  • git.commitSha
  • git.shortSha
  • vehicle.vehicle
  • vehicle.manufacturer
  • vehicle.model
  • vehicle.type
  • vehicle.fuel
  • vehicle.vin
  • vehicle.color
  • vehicle.vrm
  • vehicle.bicycle
  • music.genre
  • datatype.number
  • datatype.float
  • datatype.datetime
  • datatype.string
  • datatype.uuid
  • datatype.boolean
  • datatype.hexaDecimal
  • datatype.json
  • datatype.array
jsonfakerapi
fakeryargs
1.0.0

4 years ago