# @password-generator/check-strength > [![Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/password-generator/password-check-strength) Latest version **2.0.4** (published 2021-02-18) · MIT license · 0 weekly downloads ## Install ```sh npm install @password-generator/check-strength pnpm add @password-generator/check-strength yarn add @password-generator/check-strength bun add @password-generator/check-strength ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.0.4 | | Published | 2021-02-18 | | First published | 2020-09-17 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 15.1 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 1 | | Author | password-generator | | Maintainers | mikael-r | ## Links - npm: https://www.npmjs.com/package/@password-generator/check-strength - Repository: https://github.com/password-generator/password-check-strength - Homepage: https://github.com/password-generator/password-check-strength#readme - Issues: https://github.com/password-generator/password-check-strength/issues - npm.io page: https://npm.io/package/@password-generator/check-strength ## Recent versions - 2.0.4 (latest) — 2021-02-18 - 2.0.3 — 2021-02-18 - 2.0.2 — 2021-02-18 - 2.0.1 — 2021-02-18 - 2.0.0 — 2021-02-18 - 1.0.1 — 2020-09-19 - 0.0.1 — 2020-09-17 ## README [![Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/password-generator/password-check-strength) [![NPM Version](https://img.shields.io/npm/v/@password-generator/check-strength.svg?style=flat-square)](https://www.npmjs.com/package/@password-generator/check-strength) [![NPM Monthly Downloads](https://img.shields.io/npm/dm/@password-generator/check-strength.svg?style=flat-square)](https://npmjs.org/package/@password-generator/check-strength) [![License](https://img.shields.io/github/license/password-generator/password-check-strength?style=flat-square)](LICENSE.md) [![Last Commit](https://img.shields.io/github/last-commit/password-generator/password-check-strength?style=flat-square)](https://github.com/password-generator/password-check-strength/commits/) ![Language Most Used](https://img.shields.io/github/languages/top/password-generator/password-check-strength?style=flat-square) [![Implementations](https://img.shields.io/badge/%F0%9F%92%A1-implementations-8C8E93.svg?style=flat-square)](https://github.com/password-generator/password-check-strength/issues) ![Repository Size](https://img.shields.io/github/repo-size/password-generator/password-check-strength?style=flat-square) [![Forks](https://img.shields.io/github/forks/password-generator/password-check-strength?style=social)](https://github.com/password-generator/password-check-strength/network/members) [![Stars](https://img.shields.io/github/stars/password-generator/password-check-strength?style=social)](https://github.com/password-generator/password-check-strength/stargazers) [![Watches](https://img.shields.io/github/watchers/password-generator/password-check-strength?style=social)](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

Mikael-R mateushnsoares

[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)_ --- _Source: https://npm.io/package/@password-generator/check-strength · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._