Module: resource/util

resource/util

Helper functions.
Source:

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> getLimit(settings, defaultValue, maxValue) → {Number}

Return value of limit setting. Default value will be returned if limit field is not present in settings parameter.
Parameters:
Name Type Argument Description
settings Object <optional>
Operation settings. The object can have numeric limit field which value will be returned. Otherwise value of defaultValue parameter will be returned.
defaultValue Number <optional>
Default value of limit. maxValue is used when parameter value is not passed.
maxValue Number <optional>
Maximum value of limit. Number.MAX_VALUE is used when parameter value is not passed.
Source:
Returns:
Value that corresponds to limit 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 used
  • partialMatch - Integer - Allow partial matching: 0 - disallow (by default), 1 - allow at the beginning of matching strings, 2 - allow substring matching
  • search - 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 was searched for.
settings Object <optional>
Operation settings. The following settings are supported (name - type - description):
  • caseSensitive - Boolean - Whether case-sensitive check should be used
  • partialMatch - Integer - Allow partial matching: 0 - disallow (by default), 1 - allow at the beginning of matching strings, 2 - allow substring matching
  • search - 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
Copyright (c) 2014 Denis Sikuler
Documentation generated by JSDoc 3.2.2 on Sun Jul 13 2014 23:52:13 GMT+0400 (MSK) using the DocStrap template.