Generate Password
Generate Password is a generating random and unique passwords.
Install
$ npm install @wcj/generate-password --save
Usage
import { generate, generateMultiple, validate } from '@wcj/generate-password';
generate(); // => dK0#vA3@fG
generate({ length: 23 }); // => bB1@aO7^bF0!aA0~aQ1%aE3
generateMultiple(2, { length: 8 }); // => [ 'aG6@aC2(', 'dH0{fQ0%' ]
validate('qK0#dQ3*gG'); // => 4 Strong :) Now it's safe!
Or manually download and link generate-password.js in your HTML, It can also be downloaded via UNPKG:
<script src="https://unpkg.com/@wcj/generate-password/dist/generate-password.min.js"></script>
<script type="text/javascript">
GeneratePassword.generate(); // => dK0#vA3@fG
GeneratePassword.generate({ length: 23 }); // => bB1@aO7^bF0!aA0~aQ1%aE3
GeneratePassword.generateMultiple(2, { length: 8 }); // => [ 'aG6@aC2(', 'dH0{fQ0%' ]
GeneratePassword.validate('qK0#dQ3*gG'); // => 4, Strong :) Now it's safe!
</script>
API
generate
Create a random password
import { generate } from '@wcj/generate-password';
generate(); // => dK0#vA3@fG
generate({ length: 23 }); // => bB1@aO7^bF0!aA0~aQ1%aE3
generate({ upperCase: false }); // => n6[a3_f0$k
generate({ lowerCase: false }); // => N0(B3,C4$I
generate({ numeric: false }); // => cX*rB|jP:j
generate({ numeric: false }); // => eD3rA0gL1b
generate({ special: false, numeric: false }); // => aCaLlGfSgI
generate({ special: false, lowerCase: false, upperCase: false }); // => 4020810127
generate({ special: false, lowerCase: false, numeric: false }); // => DEEBBCBYAO
generate({ lowerCase: false, upperCase: false, numeric: false }); // => !%:#_#*&^!
generateMultiple
Create a random set of passwords
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
symbols pass with lowercase and uppercase letters, numbers and special characters
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
export declare const LOWERCASE = 'abcdefghijklmnopqrstuvwxyz';
export declare const UPPERCASE = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
export declare const NUMERIC = '0123456789';
export declare const SPECIAL_CHARACTER = '!@#$%^&*()_+~`|}{\\[\\]:;?>,.<-=\\/';
export declare type Option = {
/**
* 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 */
export declare function generate(opts?: Option): string;
/** Create a random set of passwords */
export declare function generateMultiple(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!
*/
export declare function validate(password?: string): number;
Example
import React, { useState } from 'react';
import { generate } from '@wcj/generate-password';
const Demo = () => {
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);
const opts = { lowerCase, upperCase, numeric, special, length };
const [password, setPassword] = useState(generate(opts));
return (
<div>
<div>{password}</div>
<button onClick={() => setPassword(generate(opts))}>Generate Password</button>
<div>
<label>
<input type="range" min="8" max="50" value={length} onChange={(evn) => setLength(Number(evn.target.value))} />{' '}
{length} length of password.
</label>
<br />
<label>
<input type="checkbox" checked={lowerCase} onChange={() => setLowerCase(!lowerCase)} /> Lower Case
Letter(a..z)
</label>
<br />
<label>
<input type="checkbox" checked={upperCase} onChange={() => setUpperCase(!upperCase)} /> Upper Case
Letter(A..Z)
</label>
<br />
<label>
<input type="checkbox" checked={numeric} onChange={() => setNumeric(!numeric)} /> Number (0..9)
</label>
<br />
<label>
<input type="checkbox" checked={special} onChange={() => setSpecial(!special)} /> Special characters
</label>
</div>
</div>
);
};
export default Demo;
Development
npm install # Install dependencies
npm run build # Build packages
npm run start # Run Website
cd core # Enter the `core` folder
npm run watch
npm run test
Contributors
As always, thanks to our amazing contributors!
Made with action-contributors.
License
Licensed under the MIT License.
67 Jan 3, 2023
3 Dec 15, 2022
2 Dec 11, 2022
9 Oct 24, 2022
7 Dec 6, 2022
1 Aug 16, 2022
307 Nov 3, 2022
4 Aug 8, 2022
363 Nov 12, 2022
21 Oct 28, 2022
24 Dec 20, 2022
5 Feb 2, 2022
36 Dec 22, 2022
74 Dec 24, 2022
30 Dec 25, 2022
14 Dec 11, 2022
7 Aug 7, 2022
3 Jul 8, 2022
68 Dec 25, 2022