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

Package detail

random-token

ashnur9.7kBSD-2-Clause0.0.8

Random token generation of given size

token, token-generator, key, keygen, random-token

readme

random-token

generate a (pseudo-)random string of given length composed from alphanumeric characters

install

npm install random-token

usage

initiate

var randomToken = require('random-token');

default salt is "abcdefghijklmnopqrstuvwxzy0123456789"

var token = randomToken(16); // example output → 'xg8250nbg4klq5b3'

different salt

var randomToken = require('random-token').create('abcdefghijklmnopqrstuvwxzyABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789');
var token = randomToken(16); // example output → '3ZGErMDCwxTOZYFp'

Note: valid salts are strings with length > 0 if an invalid salt is given to .create, the returned generator will use the default salt

convenience methods

.create

create a different generator

var randomToken = require('random-token').create('Aa0');
var rt = randomToken.gen('Aa0');
var token = rt(16); // example output → 'A0aAAaA0AA0Aa0AA'

.salt

you can check a generators salt by calling .salt() on it

var randomToken = require('random-token').gen('abcdefghijklmnopqrstuvwxzyABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789');
randomToken.salt(); // output → 'abcdefghijklmnopqrstuvwxzyABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'