# serialgen

> generate random serial keys

Latest version **0.3.0** (published 2021-08-03) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2021-08-03 |
| First published | 2021-08-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | safazi |
| Maintainers | safazi |
| Keywords | random, pattern, keygen, serial |

## Links

- npm: https://www.npmjs.com/package/serialgen
- npm.io page: https://npm.io/package/serialgen

## Dependencies (1)

- [chance](https://npm.io/package/chance.md) ^1.1.7

## Recent versions

- 0.3.0 (latest) — 2021-08-03
- 0.2.0 — 2021-08-03
- 0.1.1 — 2021-08-03
- 0.1.0 — 2021-08-03

## README

# serialgen
> A random string generator 🔑

## Install
```sh
npm install serialgen
```

## Usage
```js
SerialGen = require('serialgen')

// Instantiate a generator (seeded with current time)
serial = new SerialGen()

// Optionally, provide your own seed (passed to chance)
serial = new SerialGen(123456)

// Generate a string
var str = serial.gen('XXXX-XXXX-dXXX')
console.log(str) // 'OPSV-PWOW-4QQJ'

// Generate multiple strings
var strs = serial.gen('XX-dd', 3)
consolr.log(strs) // [ 'OP-78', 'PW-58', 'LQ-63' ]
```

## Handled Characters
- `X`: Capital letter
- `x`: Lowercase letter
- `d`: Digit (0-9)
- `b`: Binary digit (0-1)
- `o`: Octal digit (0-7)
- `H`: Capital hex digit (0-F)
- `h`: Lowercase hex digit (0-f)
- `A`: Capital letter or a digit
- `a`: Lowercase letter or a digit

Unhandled characters will be appended to the output string.

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