Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

random-index

mock-end65.5kMIT1.0.4

Return a random array-like index.

index, int, integer, number, generator, generate, random, randomly, randomize, chance, test, dice, mock

readme

random-index

Return a random array-like index.

MIT License

build:? coverage:?

Install

$ npm install --save random-index 

Usage

For more use-cases see the tests

var randomIndex = require('random-index');

// API:
// - randomIndex([options]);

// options
// - min
// - max


randomIndex();     
// => 3561           

randomIndex({ max: 1 });    
// => 1

randomIndex({ min:10, max: 100 });
// => 64   

Note: these min and max are inclusive, so they are included in the range.

This means randomIndex({max: 2}) would return either 0, 1, or 2.

Contributing

Pull requests and stars are highly welcome.

For bugs and feature requests, please create an issue.