Install

$ npm install @wcj/generate-password --save

Usage

import{generate,generateMultiple,validate}from'@wcj/generate-password';generate();// => dK0#vA3@fGgenerate({length:23});// => bB1@aO7^bF0!aA0~aQ1%aE3generateMultiple(2,{length:8});// => [ 'aG6@aC2(', 'dH0{fQ0%' ]validate('qK0#dQ3*gG');// => 4  Strong :) Now it's safe!

<scriptsrc="https://unpkg.com/@wcj/generate-password/dist/generate-password.min.js"></script><scripttype="text/javascript">GeneratePassword.generate();// => dK0#vA3@fGGeneratePassword.generate({length:23});// => bB1@aO7^bF0!aA0~aQ1%aE3GeneratePassword.generateMultiple(2,{length:8});// => [ 'aG6@aC2(', 'dH0{fQ0%' ]GeneratePassword.validate('qK0#dQ3*gG');// => 4,   Strong :) Now it's safe!</script>

API

generate

import{generate}from'@wcj/generate-password';generate();// => dK0#vA3@fGgenerate({length:23});// => bB1@aO7^bF0!aA0~aQ1%aE3generate({upperCase:false});// => n6[a3_f0$kgenerate({lowerCase:false});// => N0(B3,C4$Igenerate({numeric:false});// => cX*rB|jP:jgenerate({numeric:false});// => eD3rA0gL1bgenerate({special:false,numeric:false});// => aCaLlGfSgIgenerate({special:false,lowerCase:false,upperCase:false});// => 4020810127generate({special:false,lowerCase:false,numeric:false});// => DEEBBCBYAOgenerate({lowerCase:false,upperCase:false,numeric:false});// => !%:#_#*&^!

generateMultiple

import{generateMultiple}from'@wcj/generate-password';generateMultiple();// [//   'qK0#dQ3*gG', 'rQ1#lB0#kE', 'mO1#dH1_tQ', 'gE1$rE2)aJ',//   'eR6#eJ5|qE', 'rP3!cH1)aK', 'iE0#dB2$iE', 'bC0&mI1#hB',//   'kB0(eG1!lD', 'bA7>hE4)kA'// ]generateMultiple(2,{length:8});// => [ 'aG6@aC2(', 'dH0{fQ0%' ]

validate

import{validate}from'@wcj/generate-password';validate('qK0#dQ3*gG');// => 4  Strong :) Now it's safe!validate('n6[a3_f0$k');// => 3  Medium level. Enter more symbols!validate('aCaLlGfSgI');// => 2  Very Weak! It's easy to crack!validate('4020810127');// => 1  It's easy to crack!validate();// => 0

Options

exportdeclareconstLOWERCASE='abcdefghijklmnopqrstuvwxyz';exportdeclareconstUPPERCASE='ABCDEFGHIJKLMNOPQRSTUVWXYZ';exportdeclareconstNUMERIC='0123456789';exportdeclareconstSPECIAL_CHARACTER='!@#$%^&*()_+~`|}{\\[\\]:;?>,.<-=\\/';exportdeclaretypeOption={/**   * Integer, length of password.   *@default 10   */length?:number;/** Boolean, put lowercase in password */lowerCase?:boolean;/** Boolean, use uppercase letters in password. */upperCase?:boolean;/** Boolean, put numbers in password. */numeric?:boolean;/** Special characters */special?:boolean;};/** Create a random password */exportdeclarefunctiongenerate(opts?:Option):string;/** Create a random set of passwords */exportdeclarefunctiongenerateMultiple(length?:number,opts?:Option):string[];/** * symbols pass with lowercase and uppercase letters, numbers and special characters *@return [0~4] * * `4` Strong :) Now it's safe! * `3` Medium level. Enter more symbols! * `2` Very Weak! It's easy to crack! * `1` It's easy to crack! */exportdeclarefunctionvalidate(password?:string):number;

Example

importReact,{useState}from'react';import{generate}from'@wcj/generate-password';constDemo=()=>{const[lowerCase,setLowerCase]=useState(true);const[upperCase,setUpperCase]=useState(true);const[numeric,setNumeric]=useState(true);const[special,setSpecial]=useState(true);const[length,setLength]=useState(8);constopts={ lowerCase, upperCase, numeric, special, length};const[password,setPassword]=useState(generate(opts));return(<div><div>{password}</div><buttononClick={()=>setPassword(generate(opts))}>Generate Password</button><div><label><inputtype="range"min="8"max="50"value={length}onChange={(evn)=>setLength(Number(evn.target.value))}/>{' '}{length} length of password.</label><br/><label><inputtype="checkbox"checked={lowerCase}onChange={()=>setLowerCase(!lowerCase)}/> Lower Case          Letter(a..z)</label><br/><label><inputtype="checkbox"checked={upperCase}onChange={()=>setUpperCase(!upperCase)}/> Upper Case          Letter(A..Z)</label><br/><label><inputtype="checkbox"checked={numeric}onChange={()=>setNumeric(!numeric)}/> Number (0..9)</label><br/><label><inputtype="checkbox"checked={special}onChange={()=>setSpecial(!special)}/> Special characters</label></div></div>);};exportdefaultDemo;

Development

npm install# Install dependenciesnpm run build# Build packagesnpm run start# Run Websitecd core# Enter the `core` foldernpm run watchnpm runtest

Contributors

License