randdata

0.1.0 • Public • Published

randdata

A(nother) JavaScript random data generator. The main function accepts a callback and an options object. Currently the three available forms of random data are:

  • Array
  • String
  • Person

####The options object:

Options object accepts:

  • type, a string for specifying what type of data (array/string)(mandatory)
  • count, a positive integer for specifying how lengthy the data should be (mandatory)
  • Optional properties, if type is array:
    • exponent, a number for specifying exponentiation of all the elements(defaults to 1).
    • decrement, a boolean for specifying if the maximum number should get smaller throughout the loop(defaults to false).
    • unique, a boolean for specifying if all the elements in the array should be unique(defaults to false) (they all really are).
    • elementType, a string for specifying if elements should be strings or numbers(defaults to number).
  • Optional properties, if type is string:
    • maxLength, the maximum length of a string(defaults to 15).
    • loremIpsum, a boolean for specifying if the text should be lorem ipsum(defaults to false).
    • capitalLetter, a boolean for specifying if the first character should be a capital letter.
  • Optional properties, if type is person:
    • maxAge, the maximum age of a person(defaults to 80).

Any other properties will be ignored.

####The callback

The callback accepts two arguments,

  • error, which contains the error when error happens, otherwise is false.
  • result, which contains an array or a string with the results. If a wild error appears, this is false.

####Usage: Usage of array:

var randdata = require("randdata");  
randdata(function(err,result){  
	console.log(err,result);  
},{type:"array",count:5,unique:true,exponent:2})

Usage of string:

var randdata = require("randdata");  
randdata(function(err,result){  
	console.log(err,result);  
},{type:"string",count:5,maxLength:30})

Usage of person:

var randdata = require("randdata");  
randdata(function(err,result){  
	console.log(err,result);  
},{type:"person",count:10,maxAge:70})

Readme

Keywords

none

Package Sidebar

Install

npm i randdata

Weekly Downloads

0

Version

0.1.0

License

MIT

Last publish

Collaborators

  • snemvalts