1.1.4 ā¢ Published 9 months ago
node-verification-code v1.1.4
Verification code generator for Node.js
Simple library to generate verification codes without dependencies for Node.js.
This library utilizes in-built Node.js module crypto
to effective random numeric sequences generation, but also you can implement your own function to generate random sequences, using simple contract: function (charCount: number <MAX 10>) => string
Usage
If digital codes is only what you need - just use getDigitalCode
const { getDigitalCode } = require('node-verification-code')
const smsVerificationCodeBuffer = getDigitalCode(4) // Will produce Buffer contains 4 random digits
// sendSms(phone, smsVerificationCodeBuffer.toString())
You can create custom generator in two ways. Simpliest - using sequenceFromAlphabet helper function as follows:
const { sequenceFromAlphabet, createGenerator } = require('node-verification-code')
// create sequence function
const emojiSequence = sequenceFromAlphabet(['š¶', 'š±', 'š', 'š¹', 'š°'])
// create generator from sequence function
const getEmojiCode = createGenerator(emojiSequence)
getEmojiCode(4) // -> for example: š¹šš¹š°
You can also create your sequence function by hand:
const { createGenerator } = require('node-verification-code')
// only shown as example, don't do this in real code - crypto module produces better results
const mathRandomSequence = (charCount) => Math.floor(Math.random() * charCount)
const makeMyOwnVerificationCode = createGenerator(mathRandomSequence)
Install
yarn add node-verification-code
Run tests
yarn test
Author
š¤ Tominov Sergey
- Website: https://ikfi.ru
- Github: @ikenfin
Show your support
Give a āļø if this project helped you!
This README was generated with ā¤ļø by readme-md-generator