generate-password

What is generate-password?

The generate-password npm package is a utility for generating random passwords with various customizable options. It allows developers to create passwords with specific lengths, character sets, and patterns, making it useful for applications that require secure password generation.

What are generate-password's main functionalities?

Generate a simple password

This feature allows you to generate a simple password with a specified length and the inclusion of numbers. The code sample generates a 10-character password that includes numbers.

const generatePassword = require('generate-password');
const password = generatePassword.generate({
  length: 10,
  numbers: true
});
console.log(password);

Generate multiple passwords

This feature allows you to generate multiple passwords at once. The code sample generates an array of 5 passwords, each 10 characters long and without uppercase letters.

const generatePassword = require('generate-password');
const passwords = generatePassword.generateMultiple(5, {
  length: 10,
  uppercase: false
});
console.log(passwords);

Custom character set

This feature allows you to generate a password with a custom set of characters. The code sample generates a 12-character password that includes numbers, symbols, uppercase, and lowercase letters, while excluding similar characters.

const generatePassword = require('generate-password');
const password = generatePassword.generate({
  length: 12,
  numbers: true,
  symbols: true,
  uppercase: true,
  lowercase: true,
  excludeSimilarCharacters: true
});
console.log(password);

Other packages similar to generate-password

password-generator

The password-generator package is another utility for generating random passwords. It offers similar functionality to generate-password, allowing for customizable password lengths and character sets. However, it may not have as many options for excluding specific characters or generating multiple passwords at once.

secure-random-password

The secure-random-password package focuses on generating cryptographically secure passwords. It provides more advanced options for ensuring password security, such as using a secure random number generator. This package is ideal for applications that require a higher level of security compared to generate-password.

randomstring

The randomstring package is a general-purpose utility for generating random strings, which can be used for passwords. It offers flexibility in terms of character sets and string lengths, similar to generate-password. However, it is not specifically tailored for password generation and may lack some of the specialized options found in generate-password.

README

Generate Password

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.

Using this with a browser

As browsers don't have the "require" method that Node.js does, this module doesn't work in web environments. Instead generate-password-browser can be used.