Helper functions.
- Source:
Classes
Methods
-
<static> decodeHtmlEntity(str) → {String}
-
Decode HTML entities in given string.
Parameters:
Name Type Description str
String String that should be processed. - Source:
Returns:
Decoded string.- Type
- String
-
<static> getHttpRequestError(err, response) → {Error}
-
Return object that represents data about error of HTTP request.
Iferr
parameter is set then it will be returned. Otherwise instance of FailedHttpRequestError will be returned.Parameters:
Name Type Description err
Error Represents data about error. response
http.IncomingMessage Represents data about response. - Source:
Returns:
Error object.- Type
- Error
-
<static> getLimit(settings, defaultValue, maxValue) → {Number}
-
Return value of
limit
setting. Default value will be returned iflimit
field is not present insettings
parameter.Parameters:
Name Type Argument Description settings
Object <optional>
Operation settings. The object can have numeric limit
field which value will be returned if the value is positive number and not greater than maximum value. Otherwise value ofdefaultValue
parameter will be returned.defaultValue
Number <optional>
Default value of limit. maxValue
is used when parameter value is not passed or 0.maxValue
Number <optional>
Maximum value of limit. Number.MAX_VALUE
is used when parameter value is not passed.- Source:
Returns:
Value that corresponds tolimit
setting.- Type
- Number
-
<static> isRealSearchSet(settings) → {Boolean}
-
Determine whether search should be made instead of check according to operation settings.
Parameters:
Name Type Argument Description settings
Object <optional>
Operation settings. The following settings are used to specify real search (name - type - description): search
-Boolean
- Whether search should be made instead of check
- Source:
Returns:
true
if real search should be made according to settings,false
otherwise.- Type
- Boolean
-
<static> isSearchSet(settings) → {Boolean}
-
Check whether search should be made according to operation settings.
Parameters:
Name Type Argument Description settings
Object <optional>
Operation settings. The following settings are used to specify search (name - type - description): caseSensitive
-Boolean
- Whether case-sensitive check/search should be usedpartialMatch
-Integer
- Allow partial matching: 0 - disallow (by default), 1 - allow at the beginning of matching strings, 2 - allow substring matchingsearch
-Boolean
- Whether search should be made instead of check
- Source:
Returns:
true
if search should be made according to settings,false
otherwise.- Type
- Boolean
-
<static> isStringMatch(value, searchValue, settings) → {Boolean}
-
Check whether one of given strings is similar to the searched string.
Parameters:
Name Type Argument Description value
Array | String String or array of strings that should be checked. searchValue
String Value that is searched for. settings
Object <optional>
Operation settings. The following settings are supported (name - type - description): caseSensitive
-Boolean
- Whether case-sensitive check should be usedpartialMatch
-Integer
- Allow partial matching: 0 - disallow (by default), 1 - allow at the beginning of matching strings, 2 - allow substring matchingsearch
-Boolean
- Whether search should be made instead of check
- Source:
Returns:
true
if one of given strings is similar to the searched string according to settings,false
otherwise.- Type
- Boolean