-
isUuid(value)
-
Check if given string is UUID
Parameters:
| Name |
Type |
Description |
value |
string
|
The string to check |
Returns:
Returns null for all zeroes otherwise boolean
-
Type
-
boolean
|
null
-
trim(value)
-
Convert value to a trimmed string
Accepts string or number and returns empty string for anything else
Parameters:
| Name |
Type |
Description |
value |
*
|
The value |
Returns:
Returns trimmed string
-
Type
-
string
-
getRandomInt(min, max)
-
Returns a random integer between min (inclusive) and max (inclusive)
Parameters:
| Name |
Type |
Description |
min |
number
|
Minimum |
max |
number
|
Maximum |
Returns:
Returns random in range
-
Type
-
number
-
getRandomString(length [, params])
-
Get random string
Parameters:
| Name |
Type |
Argument |
Description |
length |
number
|
|
The length of a password |
params |
object
|
<optional>
|
Parameters object
Properties
| Name |
Type |
Argument |
Default |
Description |
lower |
boolean
|
<optional>
|
true
|
Include lower latin letters |
upper |
boolean
|
<optional>
|
true
|
Include upper latin letters |
digits |
boolean
|
<optional>
|
true
|
Include digits |
special |
boolean
|
<optional>
|
false
|
Include some special characters |
|
Returns:
Returns the string
-
Type
-
string
-
generatePassword()
-
Generate a password
Returns:
Returns the password
-
Type
-
string
-
encryptPassword(password)
-
Create hash of a password. Requires 'bcrypt' module.
Parameters:
| Name |
Type |
Description |
password |
string
|
The password |
Returns:
Returns the hash
-
Type
-
string
-
checkPassword(password, hash)
-
Check if password matches the hash. Requires 'bcrypt' module.
Parameters:
| Name |
Type |
Description |
password |
string
|
Password to check |
hash |
string
|
Hash of the password |
Returns:
-
Type
-
boolean
-
dashedToCamel(value [, upperFirst])
-
Convert dashed name to camel case
example-name → exampleName
Parameters:
| Name |
Type |
Argument |
Default |
Description |
value |
string
|
|
|
Dashed name |
upperFirst |
boolean
|
<optional>
|
false
|
First letter is upper case |
Returns:
Returns camel case variant
-
Type
-
string
-
camelToDashed(value)
-
Convert camel case name to dashed
exampleName → example-name
Parameters:
| Name |
Type |
Description |
value |
string
|
Camel case name |
Returns:
Returns dashed variant
-
Type
-
string
-
snakeToCamel(value [, upperFirst])
-
Convert snake case name to camel case
example_name → exampleName
Parameters:
| Name |
Type |
Argument |
Default |
Description |
value |
string
|
|
|
Snake case name |
upperFirst |
boolean
|
<optional>
|
false
|
First letter is upper case |
Returns:
Returns camel case variant
-
Type
-
string
-
camelToSnake(value)
-
Convert camel case name to snake case
exampleName → example_name
Parameters:
| Name |
Type |
Description |
value |
string
|
Camel case name |
Returns:
Returns snake case variant
-
Type
-
string