npm install randorando
=====
This is a random generator.
------
bash
$ npm install rando [ -g ]
`
Usage
javascript
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
- __type__ _required_
- __min__ _optional_ default: 0
- __max__ _optional_ default: 256
- __numbe__ _optional_ default: 1
- __file__ _optional_ default: console
- __length__ _optional_ default: 3
- __sort__ _optional_ default: false
* __TYPE__
- __int__ // default: an integer number.
- __float__ // default: a float number.
- __string__ // default: a string not a regular english word.
- __word__ // default: a regular english word.
- __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:
sh
$ 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
javascript
var rando = require('rando');
`
2. parameter
javascript
var randoInt = {
type: 'int',
min: 10,
max: 23
};
`3. pass parameter to ___rando()___
javascript
var res = rando(randoInt);
`
More examples:
Examples
Test
bash
$ npm install // install develop dependecies.
$ npm test // should install jshint first.
``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.