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

Package detail

random-char

mock-end59.3kMIT1.0.4

Return a random character.

char, character, generator, generate, random, randomly, randomize, chance, test, dice, mock

readme

random-char

Return a random character.

MIT License

build:? coverage:?

Install

$ npm install --save random-char 

Usage

For more use-cases see the tests

var randomChar = require('random-char');

// API
// - randomChar([poolName]);
// - randomChar([options]);

randomChar();
// => 'k'

By default it will return a string with random character from the following pool:

'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789~!@#$%^&()*_+-={}[]'

Optionally specify a pool:

randomChar('alpha'); // or
randomChar({alpha: true});
// => 'm'

randomChar('upper'); // or
randomChar({upper: true});
// => 'Z'

randomChar('lower'); // or
randomChar({lower: true});
// => 'j'

randomChar('number'); // or
randomChar({number: true});
// => '7'

randomChar('symbols'); // or
randomChar({symbols: true});
// => '%'

Optionally specify a pool and the character will be generated with characters only from that pool:

randomChar('abcde'); // or
randomChar({pool: 'abcde'});
// => 'c'

Contributing

Pull requests and stars are highly welcome.

For bugs and feature requests, please create an issue.