rando

This is a random generator.

Installation

  $ npm install rando [ -g ]

Usage

  var rando = require('rando');  // after install rando.
  var params = {
    type: 'int',
    min: 10,
    max: 300,
    number: 20
  };
  var res = rando(params); // res will be an array contains 20 elements.

• PARAMS
  1. __type__ _required_
  2. __min__ _optional_ default: 0
  3. __max__ _optional_ default: 256
  4. __numbe__ _optional_ default: 1
  5. __file__ _optional_ default: console
  6. __length__ _optional_ default: 3
  7. __sort__ _optional_ default: false
• TYPE
  1. __int__ // default: an integer number.
  2. __float__ // default: a float number.
  3. __string__ // default: a string not a regular english word.
  4. __word__ // default: a regular english word.
  5. __bool__ // default: a boolean value.
• min
  • int && float: the minimum number.
  • string and word: the shortest characters will be return.
• max
  • int && float: the maximum number.
  • string and word: the longest characters will be return.
• length
  • float: the decimal.
  • string and word: length of characters.
• count
  • number needed.
• file
  • output file.
• sort
  • sort the result.

Terminal Usage

How to use it:

 $ rando -t word -A 20 -Z 3

PARAMETERS

  -h, --help          // help
  -t, --type          // [REQUIRED]random type, such as: int, float, string, word...
  -A, --max           // maximum number for int and float, most characters for string and word.
  -Z, --min           // minimum number for int and float, least characters for string and word.
  -n, --number        // number needed.
  -s, --sort          // sort results;
  -f, --file          // ouput filepath.
  -l, --length        // the length for string and word, will cover min and max. or the decimal for float.
  -v, --version       // output version.

Example

1. require rando

     var rando = require('rando');  

2. parameter

       var randoInt = {
         type: 'int',
         min: 10,
         max: 23
       };

3. pass parameter to rando()

  var res = rando(randoInt);

More examples:
Examples

Test

  $ npm install // install develop dependecies.
  $ npm test   // should install jshint first.

License

Copyright (c) 2013 Allen Heavey <xheavey@gmail.com>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.