This file contains the main 'simplePass' function. This file also is used to export any other function methods that are attached to the main function. Other programs that wish to use simplePass should import this file into there program and call various functions/methods found inside of this file.
- Source:
Methods
(inner) simplePass(modifieropt, cFigopt) → {string|strengthCheckedPassword|Promise.<strengthCheckedPassword>}
Main program function. Returns either a random strin or a strength check password object that contains the a random string with additional information. If compression is configured, simplePass will return a Promise containing your strength check password object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
modifier | passwordModifier | FormData | <optional> | The available |
cFig | module:config | <optional> | The configuration settings for the program. |
- Source:
Requires:
- module:errors
- module:cleanModifier
- module:validateModifier
- module:whitespaceAttributes
- module:generateCharCode
- module:ensureRepeatingCharacters
- module:shuffle
- module:strengthChecker
- module:passwordPreConfigs
- module:messageHandler
- module:characterCodeConstraints
Throws:
Will throw an Error if the
modifierisnull,undefinedor not a JavaScript Object.- Type
- errors
Returns:
The generated password or strength checked password object.
- Type
- string | strengthCheckedPassword | Promise.<strengthCheckedPassword>