README.md

Password Generator

A small library to generate random strings

Installation

$ npm install --save @luanmuniz/password-generator

How it works

const generatePassword = require('@luanmuniz/password-generator').generate;

generatePassword({
	size: 10,
	numbers: 5,
	symbols: 3,
	allowUppercase: true,
	allowRepetintion: true
});
//=> '23393Rz@}_'

generatePassword(20, {
	numbers: 5,
	symbols: 3,
	allowUppercase: true,
	allowRepetintion: true
});
//=> ';64xxy*DC6Zyt<UjZ75B'

API

generate([size], [options])

size

Type: String The total length of your string

options

size

Type: String
Default: 15

The total length of your string

numbers

Type: Boolean or Integer
Default: 5
All Numbers allowed: 0123456789

true or false if numbers are allowed
Integers for the numbers of numbers that your final password will have

symbols

Type: Boolean or Integer
Default: 5
All Symbols allowed: !@#$%&*()_+-={}[]:;<>?,./|

true or false if numbers are allowed
Integers for the numbers of symbols that your final password will have

allowUppercase

Type: Boolean
Default: true

true or false if Uppercase characters are allowed

allowRepetintion

Type: Boolean
Default: false

true or false if your final password can have repetitive characters

Tests

npm test

Contributing

Please, check the Contributing documentation, there're just a few steps.

Support or Contact

Having trouble? Or new ideas? Post a new issue! We will be glad to help you!

License

MIT License © Luan Muniz