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

Package detail

keymachine

ozkanonur17MIT2.1.0TypeScript support: included

Zero dependency, lightweight and simple key generator for the JS world

key, keymachine, keygen, keygenerator, randomcode, randomkey, randomvalue

readme

Keymachine

Zero dependency, lightweight and simple key generator for the JS world

Usage Fields

Keymachine works very well in cases such as automatically assigned Email passwords, private invitation codes, verification keys, automatic link creation, etc.

Installation

Npm:

npm install keymachine

Yarn:

yarn add keymachine

Browsers:

<script src="https://unpkg.com/keymachine@2.1.0/index.js"></script>

Example Usage


 /*
   Default configurations comes as:
   length: 24
   possibility: 'abcdefghijklmnopqrstuvwxyz0123456789'
   case: 'mixed'
 */

 // Calling the module (only if installed via npm or yarn)
 import keymachine from 'keymachine';

 /* with defaults */
 let randomKey = keymachine();

 /* with custom configurations */
 let randomKey = keymachine({ possibility: 'KJAUZNSO27AJSND', length: 18, case: 'upper' });