1.1.1 • Published 1 year ago

codes-generator v1.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

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

KeyValue typeDescriptionDefault valueOptional?
lengthNumberThe length of the code10Yes
upperLettersBooleanInclude uppercase letters in the codetrueYes
lowerLettersBooleanInclude lowercase letters in the codetrueYes
numbersBooleanInclude numbers in the codetrueYes
symbolsBooleanInclude symbols in the codefalseYes

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
);