README.md

data-seed

Mock data for js develop.

Why?

When we are developing, we need mock data to simulate the process of online requests, which are random, readable, safe, or even illegal.

Install

npm install data-seed

Usage

const {util, seed} = require('data-seed');

// specific seed or util
const {
    util: {
        random
    },
    seed: {
        ip4
    }
} = require('data-seed');

seed.ip4(); // 23.4.126.0
ip4(); // 1.1.1.123

Seeds

• seed.avatar(): return random avatar url from https://robohash.org/.
• seed.color(): return a safe web color randomly. like DarkGreen
• seed.date([start=0, end=Date.now()]): return timestamp randomly.
  • seed.date.toSecond([start=0, end=Date.now()]): return timestamp in seconds.
  • seed.date.format(format[, start, end]): return formatted date time. see momentJS#format
• seed.email(): return email randomly.
• seed.file(): return file name randomly. like filename.jpg
  • seed.file.extension(): return file extension randomly.
• seed.hexColor(): return color hex value randomly. like #c9c9c9
  • seed.hexColor.short(): return short color hex value randomly. like #666
• seed.img(): return a img url randomly.
  • seed.img.base64(): return a img base64 string randomly.
  • seed.img.dummy([width, height, background, color]): return a dummy url, eg. https://dummyimage.com/697x903.png/000/45cb91.
• seed.ip4(): return ip4 address randomly.
  • seed.ip4.cidr(): return ip4 cidr address, like 1.1.1.1/24
  • seed.ip4.mask([start=1, end=32]): return ip4 mask, like 255.255.0.0
  • seed.ip4.mask.binary([start=1, end=32]): return ip4 mask in binary
• seed.ip6(): return ip6 address randomly.
  • seed.ip6.cidr(): return ip6 cidr address, like 65ef:57bd:f2f0:5688:8491:7713:e37a:9dc5/110
  • seed.ip6.mask([start=1, end=128]): return ip6 mask, like ffff:ffff:0:0:0:0:0:0
  • seed.ip6.mask.binary([start=1, end=128]): return ip6 mask in binary
• seed.isbn(version): return an isbn string randomly. (version 10 or 13)
• seed.lorem([min=1, max=5]): return lorem text randomly.
• seed.mac(): return mac address randomly.
• seed.md5(): return md5 string randomly.
• seed.mimeType(): return MIME Type randomly.
• seed.name(): return name randomly.
  • seed.name.en(): return name.
  • seed.name.en.firstName(): return first name.
  • seed.name.en.lastName(): return last name.
  • seed.name.cn(): return chinese name.
  • seed.name.cn.firstName(): return chinese first name.
  • seed.name.cn.lastName(): return chinese last name.
• seed.paragraph([min=1, max=10]): return paragraph text randomly.
• seed.sha([type=1]): return SHA1 or SHA256 string randomly.
• seed.time([hourType=24]): return time randomly, eg. 13:17 in default, 1:17 PM when hourType=12
• seed.url([options = {protocol:true, host: true, path: true, query: true}]): return a url randomly.
  • seed.url.protocol: return url protocol randomly, like http, file, ftp.
  • seed.url.host: return url host randomly.
  • seed.url.domain: return top level domain randomly, like com, net.
  • seed.url.path: return url path randomly.
  • seed.url.query: return url query string randomly.
• seed.uuid(): return uuid.
• seed.word([min=1, max=10]): return a word randomly.
  • seed.word.cn(): return chinese word randomly.
• seed.xss(): return xss script, eg. <script>alert("xss");</script>
  • seed.xss.noStrict(): return html text, eg. <a href="javascript:void(0)">click me!</a>

Utils

util.deep

util.deep accepts a callback function which will return data.

The callback function accepts 4 arguments:

• DEEP: identify data loop
• DONE: return DONE will stop loop
• level: record the deep level of data
• isFirst: whether first data

Create a tree nodes:

const {util: {deep}} = require('data-seed');

let data = deep((DEEP, DONE, level, isFirst) => {
    return level < 2 ? {
        name: 'lxjwlt',
        nodes: DEEP
    } : DONE;
});

/*
    data:
    {
        name: 'lxjwlt',
        nodes: {
            name: 'lxjwlt'
        }
    }
*/

util.random

• random.float([min = 0, max = 1]): create a float number randomly.

• random.int([min=0, max=1]): create a integer number randomly.

• random.letter([min='a', max='z']): create a letter randomly.

• random.array(arr): return a item within the array randomly.

• random.one([...]): return a item from arguments randomly.

• random.chance(obj): specify random probability:

  random.chance({
      '10%': 1,                       // 10% to return 1
      '0.4': 2,                       // 40% to 2
      '0.5': () => random.one(3, 4);  // 50% to 3 or 4
  });

util.arr(num, callback)

Callback function return element of array:

const {util: {arr}} = require('data-seed');

arr(2, (i) => i); // [0, 1]
arr(2, 10); // [10, 10]

util.gather(data)

const {util: {gather}} = require('data-seed');

let list = gather([1, 2, 3]);

let item1 = list.next(); // one of [1, 2, 3] randomly
let item2 = list.next(); // one of [1, 2, 3] randomly
let item3 = list.next(); // one of [1, 2, 3] randomly

item1 !== item2; // true
item2 !== item3; // true
item1 !== item3; // true

list.next(); // undefined

And support iterator:

for (let value of gather([1, 2, 3])) {
    value; // one of [1, 2, 3] randomly
}

custom seed

const dataSeed = require('data-seed');

dataSeed.register('sum', (a, b) => {
    return a + b;
});

dataSeed.seed.sum(1, 2); // 3

hook

Add hook to override data:

const dataSeed = require('data-seed');
const {seed} = dataSeed;

dataSeed.hook(() => seed.xss());

seed.ip4(); // xss string
seed.ip4.cidr(); // xss string
seed.lorem(); // xss string

Accept the value returned by last hook as first argument:

const {random} = dataSeed.util;

dataSeed.hook((value) => {
    return random.one(value, null);
});

seed.ip4(); // ip string or null

Hook for specific seed:

dataSeed.hook(seed.mac, () => seed.xss());

seed.mac(); // xss string
seed.ip4(); // ip string
seed.lorem(); // lorem string