You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
62 lines
2.5 KiB
62 lines
2.5 KiB
# Generate Password [](https://travis-ci.org/brendanashworth/generate-password) [](https://codecov.io/gh/brendanashworth/generate-password)
|
|
|
|
[](http://npmjs.org/package/generate-password)
|
|
|
|
> Generate Password is a (relatively) extensive library for generating random and unique passwords.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
$ npm install generate-password --save
|
|
```
|
|
|
|
## Usage
|
|
|
|
#### `generate([options])`
|
|
|
|
Generate one password with the given options. Returns a string.
|
|
|
|
```javascript
|
|
var generator = require('generate-password');
|
|
|
|
var password = generator.generate({
|
|
length: 10,
|
|
numbers: true
|
|
});
|
|
|
|
// 'uEyMTw32v9'
|
|
console.log(password);
|
|
```
|
|
|
|
#### `generateMultiple(amount[, options])`
|
|
|
|
Bulk generate multiple passwords at once, with the same options for all. Returns an array.
|
|
|
|
```javascript
|
|
var generator = require('generate-password');
|
|
|
|
var passwords = generator.generateMultiple(3, {
|
|
length: 10,
|
|
uppercase: false
|
|
});
|
|
|
|
// [ 'hnwulsekqn', 'qlioullgew', 'kosxwabgjv' ]
|
|
console.log(passwords);
|
|
```
|
|
|
|
### Available options
|
|
Any of these can be passed into the options object for each function.
|
|
|
|
| Name | Description | Default Value |
|
|
|--------------------------|-----------------------------------------------------------------------|---------------|
|
|
| length | Integer, length of password. | 10 |
|
|
| numbers* | Boolean, put numbers in password. | false |
|
|
| symbols* | Boolean or String, put symbols in password. | false |
|
|
| lowercase* | Boolean, put lowercase in password | true |
|
|
| uppercase* | Boolean, use uppercase letters in password. | true |
|
|
| excludeSimilarCharacters | Boolean, exclude similar chars, like 'i' and 'l'. | false |
|
|
| exclude | String, characters to be excluded from password. | '' |
|
|
| strict | Boolean, password must include at least one character from each pool. | false |
|
|
|
|
*At least one should be true.
|