Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/password-generator/password-check-strength
A simple package to check the password strength
https://github.com/password-generator/password-check-strength
algorithm hacktoberfest npm-package password password-check password-strength typescript
Last synced: about 24 hours ago
JSON representation
A simple package to check the password strength
- Host: GitHub
- URL: https://github.com/password-generator/password-check-strength
- Owner: password-generator
- License: mit
- Created: 2020-09-17T20:21:04.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-06-13T08:38:30.000Z (over 3 years ago)
- Last Synced: 2024-04-25T22:40:29.472Z (7 months ago)
- Topics: algorithm, hacktoberfest, npm-package, password, password-check, password-strength, typescript
- Language: TypeScript
- Homepage:
- Size: 22.5 KB
- Stars: 1
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://gitpod.io/#https://github.com/password-generator/password-check-strength)
[](https://www.npmjs.com/package/@password-generator/check-strength) [](https://npmjs.org/package/@password-generator/check-strength)
[](LICENSE.md) [](https://github.com/password-generator/password-check-strength/commits/)  [](https://github.com/password-generator/password-check-strength/issues) 
[](https://github.com/password-generator/password-check-strength/network/members) [](https://github.com/password-generator/password-check-strength/stargazers) [](https://github.com/password-generator/password-check-strength/watchers)
Welcome to password-check-strength 👋
🚧 password-check-strength in development... 🚧
> A simple package to check the password strength
### 🔖 Table Of Contents
- 📃 [About](#about)
- 🤔 [How To Use](#how-to-use)
- 🚀 [Technologies](#technologies)
- 🌱 [Minimal Requirements](#minimal-requirements)
- 🎊 [Features](#features)
- 🎇 [Finished](#features-finished)
- 💡 [How To Contribute](#how-to-contribute)
- 🤗 [Contributors](#contributors)
- 👤 [Author](#author)
- 🔏 [License](#license)
---
📃 About
#### Password Strength Algorithm
##### Password Length:
5 Points: Less than 4 characters
10 Points: 5 to 7 characters
25 Points: 8 or more
##### Letters:
0 Points: No letters
10 Points: Letters are all lower case
20 Points: Letters are upper case and lower case
##### Numbers:
0 Points: No numbers
10 Points: 1 number
20 Points: 3 or more numbers
##### Characters:
0 Points: No characters
10 Points: 1 character
25 Points: 3 or more characters
##### Bonus:
2 Points: Letters and numbers
3 Points: Letters, numbers, and characters
5 Points: Mixed case letters, numbers, and characters
##### Password Text Range:
>= 90: Very Secure
>= 80: Secure
>= 70: Very Strong
>= 60: Strong
>= 50: Average
>= 25: Weak
>= 0: Very Weak
[Back To The Top](#title)
---
🤔 How To Use
```typescript
import { checkStrength } from '@password-generator/password-check-strength';
import { generatePassword, Preferences } from '@password-generator/package';
const preferences: Preferences = {
length: 12,
useChars: {
pronounceable: false,
lowercase: true,
uppercase: true,
numbers: true,
symbols: true,
},
};
const password = generatePassword(preferences);
const result = checkStrength(password);
console.log(result);
```
[Back To The Top](#title)
---
🚀 Technologies
- Typescript
- NodeJs
[Back To The Top](#title)
---
🌱 Minimal Requirements
- NodeJs
- NPM/Yarn
[Back To The Top](#title)
---
🎊 Features
🎇 Finished
- [x] Create the algorithm
- [x] Identify special characters automatically
[Back To The Top](#title)
---
💡 How To Contribute
- Make a fork of this repository
- Clone to you machine and entry on respective paste
- Create a branch with your resource: `git checkout -b my-feature`
- Commit your changes: `git commit -m 'feat: My new feature'`
- Push your branch: `git push origin my-feature`
- A green button will appear at the beginning of this repository
- Click to open and fill in the pull request information
Contributions, issues and features requests are welcome!
📮 Submit PRs to help solve issues or add features
🐛 Find and report issues
🌟 Star the project
[Back To The Top](#title)
---
🤗 Contributors
[Back To The Top](#title)
---
👤 Author
🤓 **password-generator **
- Github: [@password-generator](https://github.com/password-generator)
[Back To The Top](#title)
---
🔏 License
Copyright © 2020 [password-generator ](https://github.com/password-generator)
This project is licensed by [MIT License](https://api.github.com/licenses/mit).
[Back To The Top](#title)
---
_This README was generated with 💟 by [readme-template-generator](https://github.com/Mikael-R/readme-template-generator)_