Have ideas to improve npm?Join in the discussion! »

generate-password
TypeScript icon, indicating that this package has built-in type declarations

1.6.0 • Public • Published

Generate Password Build Status codecov

Generate-Password NPM

Generate Password is a (relatively) extensive library for generating random and unique passwords.

Install

$ npm install generate-password --save

Usage

generate([options])

Generate one password with the given options. Returns a string.

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.

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.

Install

npm i generate-password

DownloadsWeekly Downloads

120,927

Version

1.6.0

License

MIT

Unpacked Size

22.4 kB

Total Files

12

Last publish

Collaborators

  • avatar