Cheatsheet

On this page you get a quick view over the usable "public" functions.

Methods

Initialisation

This is the complete set of all options you can set/ override.

Bind info box to a password field

get checks

Get an overview about the current requirements for the password check and weights of each check.

Return is an object


get score

Get a value how many checks were fulfilled. You can use this function to verify the password in the onsubmit event of your form.

Return is a float 0..1


get result

Get the result of the checks. You can use this function to verify the password in the onsubmit event of your form.

Return is an object


Key Description
count count of fullfilled required checks {integer}
required Count of checks {integer}
check result: all checks fulfilled? {boolean}
score score {float}; see getScore()

Keys

Names of the keys in language texts and checks.

Key Check
introtext Pre text before boxes for each check
lcase Check for lower case character; a-z
ucase Check for upper case character; A-Z
digits Check for digits; characters 0-9
special Check for special characters; everything that is not a letter a-z/ A-Z or a digit 0-9
count Check for count of characters

Replacements

List of pre defined placeholders.

Key Description
[COUNT] Count of detected characters in a check. In the introtext it is the count of fullfilled required checks
[REQUIRED] Count of required characters in a check; remark: you can override it for each check
[SCORE] score value; available in introtext only






Copyright © 2021 Axel Hahn
project page: GitHub (en)
results will be here