2.0.1 • Published 2 years ago
genepass v2.0.1
Genepass v2.0.1
Generate a random customizable passwords
Installation
Using npm
$ npm i --save genepass
Usage
In Node.js
"length" of password generated must be defined, then "lowercase", "uppercase" or "number" must exists next to this.
const genepass = require('genepass');
const password = genepass.build({
length: 12, // Required attribute
lowercase: true,
uppercase: true,
number: true,
special: true,
});
/**
* Return example
* password = "!UghH1!#e21T"
* /
Supported attributes
Attribute | Data Type | Description | Required | Default |
---|---|---|---|---|
length | Number | Length of generated password, between 0 and 2048 | true | - |
lowercase | Boolean | At least one lowercase word in the generated password | false | false |
uppercase | Boolean | At least one uppercase word in the generated password | false | false |
number | Boolean | At least one number in the generated password | false | false |
special | Boolean | At least one special character in the generated password. Could include: $ , % , @ , ! , ? , # | false | false |
Important
length
attribute is required- It is necesary choose one of attribute apart of
length
.
Supported format examples
Return a combination lowercase uppercase password and 8 of length
const genepass = require('genepass');
const password = genepass.build({
length: 8,
lowercase: true,
uppercase: true,
});
/**
* Return example
* password = "ReyDFHbp"
* /
Return a PIN and 6 of length
const genepass = require('genepass');
const password = genepass.build({
length: 6,
number: true,
});
/**
* Return example
* password = "218152"
* /
Return a hard password
const genepass = require('genepass');
const password = genepass.build({
length: 32,
lowercase: true,
uppercase: true,
number: true,
special: true,
});
/**
* Return example
* password = "t13Yq#Kb1D%%pF%SM@121%4#k!jjTq1Q"
* /