Collection of helper functions for validating data
- Source:
- Copyright:
- 6/27/19
Methods
(inner) validateInteger(jrResult, keyname, val, flagRequired)
- Source:
Validate a number.
Parameters:
| Name | Type | Description |
|---|---|---|
jrResult |
obj | existing JrResult objec to push errors into |
keyname |
string | name of the property we are validating, used only for error generation |
val |
int | the value we are validating |
flagRequired |
boolean | if true, it will be an error if value is undefined or null |
Returns:
integer value, or undefined if invalid (with JrResult containing error)
(inner) validateIntegerRange(jrResult, keyname, val, min, max, flagRequired)
- Source:
Validate a number in a [min,max] range
Parameters:
| Name | Type | Description |
|---|---|---|
jrResult |
obj | existing JrResult objec to push errors into |
keyname |
string | name of the property we are validating, used only for error generation |
val |
int | the value we are validating |
min |
int | minimum value considered valid |
max |
int | maximum value considered valid |
flagRequired |
boolean | if true, it will be an error if value is undefined or null |
Returns:
integer value, or undefined if invalid (with JrResult containing error)
(inner) validateJsonObjOrStringToObj(jrResult, keyname, val, flagRequired)
- Source:
Validates an object to yield proper json, or a json string, which is converted to a json object
Parameters:
| Name | Type | Description |
|---|---|---|
jrResult |
* | |
keyname |
* | |
val |
* | |
flagRequired |
* |
Returns:
a json object or sets error in jrResult
(inner) validateRealName(jrResult, keyname, str, flagRequired)
- Source:
Validate a name. This code currently just calls validateString.
Parameters:
| Name | Type | Description |
|---|---|---|
jrResult |
obj | existing JrResult objec to push errors into |
keyname |
string | name of the property we are validating, used only for error generation |
str |
string | the value we are validating |
flagRequired |
boolean | if true, it will be an error if value is blank |
Returns:
validated string or undefined if invalid (with JrResult containing error)
(inner) validateString(jrResult, keyname, str, flagRequired)
- Source:
Validate a string. Just check that it's non-blank if so requested.
Parameters:
| Name | Type | Description |
|---|---|---|
jrResult |
obj | existing JrResult objec to push errors into |
keyname |
string | name of the property we are validating, used only for error generation |
str |
string | the value we are validating |
flagRequired |
boolean | if true, it will be an error if value is blank |
Returns:
validated string or undefined if invalid (with JrResult containing error)
(inner) validateTrueFalse(jrResult, keyname, val, flagRequired)
- Source:
Validate a true|false value.
Parameters:
| Name | Type | Description |
|---|---|---|
jrResult |
obj | existing JrResult objec to push errors into |
keyname |
string | name of the property we are validating, used only for error generation |
val |
boolean | the value we are validating |
flagRequired |
boolean | if true, it will be an error if value is undefined or null |
Returns:
true or false, or undefined if invalid (with JrResult containing error)