mokapjs v0.0.3

MokapJS

Introduction

About Mokap.js

Mokap is a data modeling utility used to build fast and easy json mock-ups.

Getting started

Installation

with npm

$ npm install --save mokapjs

with yarn

$ yarn add mokapjs

Add mokap to your application

Import only what you need

const { arr, bool, str } = require('mokapjs');

Or import everything into a namespace (here, mokap)

const mokap = require('mokapjs');

First steps

Modeling data with mokap is pretty straight forward. Data structures follow a JSON like format for ease of use.

Generators

A generator is a function which, when called, will return a mock-up value of a predefined type.

Example of a string generator

const { str } = require('mokapjs');

// Creating a generator
const hello = str('world');

console.log(hello);
// output: [Function]

console.log(hello());
// output: world

Basic Generators

Boolean

Simple Boolean Generator

const { bool } = require('mokapjs');
const boolGen = bool();

console.log(boolGen());
// output: true | false

String

Simple String Generator

const { str } = require('mokapjs');
const strGen = str('text');

console.log(strGen());
// output: text

Random generation with fixed-length

// Generator will output a random string of length 12 when called.
const fixedLengthGen = str({ length: 12 });

console.log(fixedLengthGen());
// output: Ze1DJsi86asP | 6l237qUKx5ze etc...

Random string generation with variable-length

// Generator will output a random string of length 3 to 10 when called.
const strGenerator2 = str({ length: { min: 3, max: 10 } });

console.log(strGenerator());
// output: Ze1DJs | 6l237qUKx etc...

Random string generation with fixed or variable length & filter

console.log(str({ length: 12, filter: /[A-Z]/ })());
// output: SHJDIZOLJDSK | NCKEUVGQOEDX etc...

console.log(str({ length: { min: 3, max: 10 }, filter: /[a-z0-9]/ })());
// output: q25d | 4g25e8dsz etc...

Random string generation using a Regular Expression

const strGenerator = str(/[a-z]{3, 6}@[a-z]mail.com/);

console.log(strGenerator());
// output: fmox@imail.com | rxb@dmail.com | pnyae@gmail.com etc...

Random string element from an array

const strGenerator = str(['hello', 'hi', 'world']);

console.log(strGenerator());
// output: hello | world | hi

Number

Date

Recursive Generators

A recursive type is a data type that can contain other generators.

Map

A map corresponds to a javascript object.

const { map } = require('mokapjs');

Creating a Map Generator

const mapGenerator = map({
    field1: value1,
    field2: value2,
    ...,
    fieldN: valueN
})

Field values can either be a fixed value or a generator of any kind.

Example

const mapGenerator = map({
    field1: value1,
    field2: value2,
    ...,
    fieldN: valueN
})

Array

Custom Generators