otp-gen-agent

A small and secure one time password (otp) generator for Javascript based on nanoid.

If you find this utility library useful, you can buy me a coffee to keep me energized for creating libraries like this.

Installation

npm install otp-gen-agent --save

Usage

Mobile number has become the defacto user authentication mechanism in India and hence, OTP generation is a very common phenomena. This is a small utility lib to generate OTP.

default

1const { otpGen } = require('otp-gen-agent');
2
3const otp = await otpGen(); // '344156'  (OTP length is 6 digit by default)
4

• Default OTP lenght is 6
• Default characters used to generate OTP is 0123456789

custom otp generator

1const { customOtpGen } = require('otp-gen-agent');
2
3const otp = await customOtpGen({length: 4, chars: 'abc123'}); // 'a3c1'
4

Arguments:

• options: optional
  • length: custom otp length
  • chars: custom characters

You can customise the OTP length and also the characters to be used for OTP generation.

• Default OTP lenght is 6.
• Default characters used to generate OTP is 0123456789

bulk otp generator

1const { bulkOtpGen } = require('otp-gen-agent');
2
3const otp = await bulkOtpGen(2); // Array of otps: ['344156', '512398']
4

1const { bulkOtpGen } = require('otp-gen-agent');
2
3const otp = await bulkOtpGen(2, {length = 5, chars: 'abcd123'} ); // Array of otps: ['312b3', 'bcddd']
4

Arguments:

• num: number of OTPs to be generated in bulk
• opts: optional argument
  • length: custom otp length (default: 6)
  • chars: custom characters (default: 0123456789)

Useful in cases where number of OTPs to be generated is known before hand.

Test

npm run test

Read More

Read more in detail at A One Time Password (OTP) generator

License

MIT

If you find this utility library useful, you can buy me a coffee to keep me energized for creating libraries like this.

Tech Blog

Read my blog at Tech Insights: Personal Tech Blog