npm.io
1.0.1 • Published 7 years ago

randing

Licence
MIT
Version
1.0.1
Deps
0
Size
26 kB
Vulns
0
Weekly
0
Stars
3

logo


travis-badge language-badge licence-badge jest-badge

Random + String = Randing. Easily generate configurable random string and token

Installation

Easy installation using yarn or npm:

yarn add randing
  # or
npm install randing --save

Usage

const randing = require('randing');

console.log(randing()); 	// UIVfjWVjN1UjyhMepVXPtcnVO9yi7uENJULhhbQMxpot2o2rP6
console.log(randing(10));	// ejcWWx3coe
console.log(randing(60, {
    special:true,
    uppercase:false,		// n-*sh[]b@q?le<p>||p<kh}ua}:d+r|eq?t}!.}.gl@hkgfad|t{.@:z=ujq
    figures:false,
}));
console.log(randing(60, {
    alphabet:'azerty',		// teeerrrtezezytyytarz
}))

API

randing(length, [config]) ⇒ string

Generate a random string (token)

Kind: global function
Returns: string - - A random string of size length

Param Type Default Description
length number 50 Length (in character) of the returned string
[config] object Configuration for the token generation
[config.lowercase] boolean true Allow lowercase letters in the token
[config.uppercase] boolean true Allow uppercase letters in the token
[config.figures] boolean true Allow figures in the token
[config.special] boolean false Allow special characters in the token
[config.alphabet] string A string of characters to generate the random token from

Credit

Created by Corentin Thomasset.