Skip to content

roggervalf/fake-gen

Repository files navigation

fake-gen

NPM code style: prettier Build Status NPM downloads Coverage Status deno doc semantic-release

About

Faker data generator, progressive refactor from faker

Install

npm install --save fake-gen

Or

yarn add fake-gen

Deno import

// @deno-types="https://raw.githubusercontent.com/roggervalf/fake_gen/master/dist/main.d.ts"
import {
  DateTime,
  Internet,
  Random,
  Unique,
  Vehicle
} from 'https://raw.githubusercontent.com/roggervalf/fake_gen/master/dist/main.es.js';

or

// @deno-types="https://deno.land/x/fake_gen@master/dist/main.d.ts"
import {
  DateTime,
  Internet,
  Random,
  Unique,
  Vehicle
} from 'https://deno.land/x/fake_gen@master/dist/main.es.js';

Node import

import { DateTime, Internet, Random, Unique, Vehicle } from 'fake-gen';

Example:

const { DateTime, Internet, Random, Unique, Vehicle } = require('fake-gen');

const dateTime = new DateTime();

console.log(dateTime.past());
// expects a random date instance between 1 year in the past and now

console.log(dateTime.future());
// expects a random date instance between 1 year in the future and now

const random = new Random();

console.log(random.alpha());
// expects a random character from 'a' to 'z'

console.log(random.alphaNumeric());
// expects a random character from 'a' to 'z' or '0' to '9'

console.log(random.arrayElement([1, 2, 3]));
// expects a random element from the provided array, i.e: 2

console.log(random.boolean());
// expects a random boolean, i.e: false

console.log(random.float());
// expects a random float number, i.e: 43173.42

console.log(random.hexadecimal());
// expects a random hexadecimal expression, i.e: 0xF

console.log(random.number(100));
// expects a random number from 0 to 100

console.log(random.uuid());
// expects a random uuid, i.e: 49e71c40-9b21-4371-9699-2def33f62e66

random.initSeed(100);
console.log(random.number(100));
// expects a 54

const internet = new Internet();

console.log(internet.avatar());
// expects a random avatar uri, i.e: https://randomuser.me/api/portraits/women/54.jpg

console.log(internet.ip());
// expects a random IP, i.e: 200.105.198.100

console.log(internet.ipv6());
// expects a random IPv6, i.e: 9cda:87cd:9617:370e:8d56:d698:19c8:c195

console.log(internet.protocol());
// expects a random ip, i.e: https

const vehicle = new Vehicle();

console.log(vehicle.vin());
// expects a random vehicle identification number, i.e: YV1MH682762184654

console.log(vehicle.vrm());
// expects a random vehicle registration mark, i.e: GL19AAQ

const unique = new Unique();

console.log(
  unique.execute({
    scope: 'scope',
    method: random.arrayElement,
    args: [[1, 2, 3]],
    model: random
  })
);
// expects a random unique value from arrayElement function, scoped by 'scope' string, i.e: 1

Methods

  • dateTime
    • future
    • past
  • internet
    • avatar
    • ip
    • ipv6
    • protocol
  • random
    • alpha
    • alphaNumeric
    • arrayElement
    • boolean
    • float
    • hexadecimal
    • number
    • uuid
  • unique
    • clear
    • execute
  • vehicle
    • vin
    • vrm

Article

How to build a Deno module

Contributing

Fork the repo, make some changes, submit a pull-request! Here is the contributing doc that has some details.

License

MIT © roggervalf