Skip to content

Latest commit

 

History

History
55 lines (42 loc) · 2.51 KB

readme.md

File metadata and controls

55 lines (42 loc) · 2.51 KB

js-password-gen

Password generator using JS for NodeJS

Installation

Install js-password-gen with npm

//Production dependencie
npm install js-password-gen

//Developer dependencie
npm install js-password-gen -D

Usage

  • NodeJS syntax

    //@ts-check
    const generatePassword = require("js-password-gen");
    const password = generatePassword(length, options);
    /*
    length: Number,
    options: { chars: boolean, upperCase?: boolean, numbers?: boolean, symbols?: boolean }
    */
  • Example:

    //@ts-check
    const generatePassword = require("js-password-gen");
    const password = generatePassword(16, {chars: true, symbols: true, numbers: true, upperCase:true})
    console.log(`password:`, password) //password: #YP]%#x]u3K:/Z0;

length - Number

  • Type number
  • Default value: 8
  • Max value: 64

{ options } - Object

Prop Type Description Required
chars boolean Include characters in your password.
upperCase boolean Include upper case characters in your password.
numbers boolean Include numbers in your password.
symbols boolean Include symbols in your password.

Authors