https://github.com/scriptex/pass-score
Get the score of your password as a number
https://github.com/scriptex/pass-score
password-safety password-strength web-component
Last synced: 7 months ago
JSON representation
Get the score of your password as a number
- Host: GitHub
- URL: https://github.com/scriptex/pass-score
- Owner: scriptex
- License: mit
- Created: 2018-01-14T12:18:06.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-07T05:09:15.000Z (7 months ago)
- Last Synced: 2025-03-18T04:42:42.837Z (7 months ago)
- Topics: password-safety, password-strength, web-component
- Language: TypeScript
- Homepage: https://pass-score.atanas.info/
- Size: 945 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.com/scriptex/pass-score)
[](https://github.com/scriptex/pass-score/actions?query=workflow%3ABuild)
[](https://www.codacy.com/gh/scriptex/pass-score/dashboard?utm_source=github.com&utm_medium=referral&utm_content=scriptex/pass-score&utm_campaign=Badge_Grade)
[](https://codebeat.co/projects/github-com-scriptex-pass-score-master)
[](https://www.codefactor.io/repository/github/scriptex/pass-score)
[](https://deepscan.io/dashboard#view=project&tid=3574&pid=5257&bid=40799)
[](https://github.com/scriptex/pass-score/)
# Pass Score
> Get the score of your password as a number.
> The number can be between 0 and the length of the provided array containing the conditions against which the password will be tested.
## Visitor stats
## Code stats
## Install
```sh
npm i pass-score
```
or
```sh
yarn add pass-score
```
## Usage
First import the function
```javascript
import passScore from 'pass-score';
// or
import { passScore } from 'pass-score';
```
Then use it with the default patterns:
```javascript
// Returns a number between 0 and 4
const score = passScore('Your-passW0rd-Str1ng');
```
Or with custom patterns:
```javascript
// Returns a number between 0 and 2
const score = passScore('Your-passW0rd-Str1ng', [
/[\W_,!?@*\(\)]/, // Special characters
/^.{8}/ // At least 8 characters
]);
```
## Arguments
The function accepts two arguments:
1. The first is the password string. It is required.
2. The second is an array of regular expressions. It is optional. The default array is shown below.
## Conditions
The predefined array with conditions contains the following:
1. `/\d/` - The password should contain at least on digit
2. `/[A-Z]/`, - The password should contain at least one uppercase letter
3. `/[\W_,!?@*\(\)]/` - The password should contain at least one special character
4. `/^.{8}/` - The password should be at least 8 characters long
## Bonus
The `pass-score` module provides a native web component. In order to use it you can `import` it:
```javascript
import 'pass-score/component';
```
and then use it as shown in the [demo](https://pass-score.atanas.info).
The component accepts one attribute `patterns` which is a comma separated list of regular expressions against which the password will be matched.
## LICENSE
MIT
---
Connect with me:
---
Support and sponsor my work:
