codes-generator
TypeScript icon, indicating that this package has built-in type declarations

1.1.1 • Public • Published

Codes Generator

An NPM package for generating random codes

Getting started

  • Install the package
npm install codes-generator
  • Import the generate function from the installed package
const { generate } = require("codes-generator");
  • Use the function
console.log(
  generate(10, {
    upperLetters: true,
    lowerLetters: true,
    numbers: true,
    symbols: false,
  })
);

Function options

Key Value type Description Default value Optional?
length Number The length of the code 10 Yes
upperLetters Boolean Include uppercase letters in the code true Yes
lowerLetters Boolean Include lowercase letters in the code true Yes
numbers Boolean Include numbers in the code true Yes
symbols Boolean Include symbols in the code false Yes

Example

const { generate } = require("codes-generator");

console.log(
  generate(20, {
    lowerLetters: false,
    upperLetters: true,
    numbers: false,
    symbols: true,
  }) // Returns a string of 20 characters containing uppercase letters and symbols
);

Package Sidebar

Install

npm i codes-generator

Weekly Downloads

11

Version

1.1.1

License

MIT

Unpacked Size

4.91 kB

Total Files

6

Last publish

Collaborators

  • cicciofrollo