codes-generator
v1.1.1
Published
An NPM package for generating random codes
Downloads
56
Maintainers
Readme
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
);