# keygenerator

> Random key generator for node.js

Latest version **1.0.4** (published 2015-05-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install keygenerator
pnpm add keygenerator
yarn add keygenerator
bun add keygenerator
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2015-05-28 |
| First published | 2013-03-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | * |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 17 |
| Author | Marc Riegel |
| Maintainers | mrcrgl |
| Keywords | key, random, string, password, session_id |

## Links

- npm: https://www.npmjs.com/package/keygenerator
- Repository: https://github.com/mrcrgl/node-keygen
- Issues: https://github.com/mrcrgl/node-keygen/issues
- npm.io page: https://npm.io/package/keygenerator

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2015-05-28
- 1.0.2 — 2013-03-04
- 1.0.1 — 2013-03-04
- 1.0.0 — 2013-03-01

## README

node-keygen // keygenerator [![Build Status](https://secure.travis-ci.org/mrcrgl/node-keygen.png)](http://travis-ci.org/mrcrgl/node-keygen)
=================

Random String generator for node.js

## Installation

```shell
npm install keygenerator --save
```

## Usage

```javascript
var keygen = require("keygenerator");

/*
 * Default configuration
 *
 * chars: true
 * sticks: false
 * numbers: true
 * specials: false
 * sticks: false
 * length: 8
 * forceUppercase: false
 * forceLowercase: false
 * exclude:[ ]
 *
 */
keygen._();
// >> "8MRXnoG3nTmjb35U0tFwnoZpdCBBj5EX"

keygen._({
    forceUppercase: true
});
// >> "F4ZCPNOX7BWK7XWDXGSA5BPHCCCLGCRZ"

keygen._({
    specials: true
});
// >> "3L0KpE{pb.U3(Tu42,*,aNxBpb(}Mfy|"

/*
 * Configuration for password()
 *
 * chars: true
 * sticks: false
 * numbers: true
 * specials: false
 * length: 8 <- overrideable
 * forceUppercase: false
 * forceLowercase: false
 * exclude:['O', '0', 'I', '1']
 *
 */
keygen.password();
// >> "d4pTgrCY"

/*
 * Configuration for session_id()
 *
 * chars: true
 * sticks: true
 * numbers: true
 * specials: false
 * length: 32 <- overrideable
 * forceUppercase: false
 * forceLowercase: false
 * exclude:[ ]
 *
 */
keygen.session_id();
// >> "7YFSfsiM3NgE76fZa5vrjHmftKZwuiJv"

/*
 * Configuration for transaction_id()
 *
 * chars: true
 * sticks: true
 * numbers: true
 * specials: true
 * length: 6 <- overrideable
 * forceUppercase: false
 * forceLowercase: false
 * exclude:[ ]
 *
 */
keygen.transaction_id();
// >> "lTrGjp"

/*
 * Configuration for transaction_id()
 *
 * chars: false
 * sticks: false
 * numbers: true
 * specials: false
 * length: 8 <- overrideable
 * forceUppercase: false
 * forceLowercase: false
 * exclude:[ ]
 *
 */
keygen.number();
// >> "37883189"

```

## API

You can parse each function with a object. Following options are available:

chars (bool)
> ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz


sticks (bool)
> -_


numbers (bool)
> 0123456789


specials (bool)
> ,.;:#*?=)(/&%$§"!¡“¢[]|{}≠@


length (integer)
> length of the key


forceUppercase (bool)
> convert key to lowercase


forceLowercase (bool)
> convert key to uppercase


exclude
> Array of chars to exclude

## Licence

Module is licenced under the [MIT](http://opensource.org/licenses/MIT)

---
_Source: https://npm.io/package/keygenerator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._