# otp-generator

> One time password generator

Latest version **4.0.1** (published 2023-02-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install otp-generator
pnpm add otp-generator
yarn add otp-generator
bun add otp-generator
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 4.0.1 |
| Published | 2023-02-03 |
| First published | 2016-03-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/otp-generator) |
| Module format | CommonJS |
| Node | >=14.10.0 |
| Dependencies | 0 |
| Unpacked size | 6.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 75 |
| Author | Maheshkumar Kakade |
| Maintainers | maheshkumar-kakade |
| Keywords | OTP, password-generator, password, generator |

## Links

- npm: https://www.npmjs.com/package/otp-generator
- Repository: https://github.com/Maheshkumar-Kakade/otp-generator
- Homepage: https://github.com/Maheshkumar-Kakade/otp-generator#readme
- Issues: https://github.com/Maheshkumar-Kakade/otp-generator/issues
- npm.io page: https://npm.io/package/otp-generator

## Recent versions

- 4.0.1 (latest) — 2023-02-03
- 4.0.0 — 2021-11-23
- 3.0.0 — 2021-10-17
- 2.0.1 — 2021-06-07
- 2.0.0 — 2020-08-09
- 1.1.0 — 2016-07-31
- 1.0.1 — 2016-04-21
- 1.0.0 — 2016-04-17
- 0.0.1 — 2016-03-27

## README

#otp-generator

> 'otp-generator' is simple one time password generator and can be used as password generator.

[![Build Status][travis-ci-img]][travis-ci-url] 
[![npm version][npm-version-img]][npm-version-url]
![npm](https://img.shields.io/npm/dm/otp-generator?style=plastic)
[![Test Coverage][coveralls-image]][coveralls-url]
[![js-standard-style][js-standard-style-img]][js-standard-style-url] 

[![NPM](https://nodei.co/npm/otp-generator.png?downloadRank=true&downloads=true)](https://nodei.co/npm/otp-generator/)

## Index
* [Install](#install)
* [Usage](#usage)
* [Test](#test)
* [License](#license)

## Install

```bash
npm install otp-generator --save
```

## Usage

```js
const otpGenerator = require('otp-generator')

otpGenerator.generate(6, { upperCaseAlphabets: false, specialChars: false });

```
### generate(length, options)

**Arguments**

* `length` - length of password. Optional if `options` is optional. default length is 10.
* `options` - optional
  - `digits` - Default: `true` true value includes digits in OTP 
  - `lowerCaseAlphabets` - Default: `true` true value includes lowercase alphabets in OTP
  - `upperCaseAlphabets` - Default: `true` true value includes uppercase alphabets in OTP
  - `specialChars` - Default: `true` true value includes special Characters in OTP

## Tests

```js
npm test
```

## License
[MIT][license-url]

[license-image]: http://img.shields.io/badge/license-MIT-blue.svg?style=flat
[license-url]: LICENSE
[travis-ci-img]: https://travis-ci.org/Maheshkumar-Kakade/otp-generator.svg?branch=master
[travis-ci-url]: https://travis-ci.org/Maheshkumar-Kakade/otp-generator 
[npm-version-img]: https://badge.fury.io/js/otp-generator.svg
[npm-version-url]: http://badge.fury.io/js/otp-generator
[coveralls-image]: https://coveralls.io/repos/github/Maheshkumar-Kakade/otp-generator/badge.svg?branch=master
[coveralls-url]: https://coveralls.io/github/Maheshkumar-Kakade/otp-generator?branch=master
[js-standard-style-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[js-standard-style-url]: http://standardjs.com/

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