npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

generate-verification-code

v1.0.2

Published

NPM library to generate verification code for sms or email

Downloads

9

Readme

Generate Verification Code

A simple NPM package to generate verification code for sms or email

Installation

You can install the generate-verification-code library using npm or yarn:

npm install generate-verification-code
# or
yarn add generate-verification-code

Usage

To generate a verification code using the library, follow these steps:

  1. Import the library:
import { generateVerificationCode } from 'generate-verification-code';

//or

const { generateVerificationCode } = require('generate-verification-code');
  1. Call the generateVerificationCode function with optional parameters:
// Default options: length = 6, type = 'number'
const verificationCode1 = generateVerificationCode();

// Custom options: length = 4, type = 'string'
const verificationCode2 = generateVerificationCode({
    length: 4,
    type: 'string',
});
  1. Use the generated verification code:
console.log('Verification Code 1:', verificationCode1);
console.log('Verification Code 2:', verificationCode2);

API

generateVerificationCode(options) Generates a verification code based on the provided options.

  • options (optional): An object containing the following optional properties:
    • length (optional): The length of the verification code. Default is 6. If type is number then maximum value of the length will be 16. Length should be greater than zero.s
    • type (optional): The type of verification code to generate. Can be 'string' or 'number'. Default is 'number'.

Returns the generated verification code as a string or number, based on the specified type in the options.

Error Handling

The library handles various error scenarios, such as invalid options or input. If an error occurs, the library will throw an error with a descriptive message.

try {
    const verificationCode = generateVerificationCode({
        length: -1,
        type: 'number'
    });
} catch (error) {
    console.error('Error:', error.message);
}