passwagen v1.0.0

⚙️ Installation

npm i passwagen

📖 Usage

▣ Import

// ES6
import passwagen from "passwagen";

// commonjs
const passwagen = require("passwagen");

▣ Generate

const password = passwagen();

console.log(password);

▣ Generate with options for characters

const password = passwagen({
    numbers: true,      // (Boolean) Include numbers
    uppercase: true,    // (Boolean) Include uppercase letters
    lowercase: true,    // (Boolean) Include lowercase letters
    symbols: true,      // (Boolean) Include symbols "!@#$%^&*()_+-="
    punctuation: true,  // (Boolean) Include punctuations "!@#$%^&*()_+~`|}{[]\:;?><,./-="
    characters: "abc"   // (String) Add characters that may also be used
});

console.log(password);

▣ Generate with options for length and amount

const password = passwagen({
    length: 10, // (Number) Length of password
    amount: 20  // (Number) Amount of passwords to generate
});

console.log(password);

If the amount is one (by default) then it will return a string otherwise it will return an array of strings.

▣ Generate with strict mode

const password = passwagen({
    strict: true // (Boolean)
});

console.log(password);

strict mode will make sure that the password uses atleast one character from each field (numbers, lowercase, etc.)

But for example, if punctuation is set to false (by default) strict mode won't make the password include punctuation.

▣ Generate with custom character set

const password = passwagen({
    characters: "abc",  // (String)
    custom: true        // (Boolean)
});

console.log(password);

Setting custom to true will make it use only the characters that you provide.

Support me on Patreon - Check out my socials