Due to a ransomware attack, the wiki was reverted to a July 2022 version. . We apologize for the lack of a more recent valid backup.
FnService - Function Service
FnService is an Angular Factory in the Util module with the name fn.js. It provides general purpose functions that are useful throughout the client-side application. To use these functions, see the documentation on injecting Angular services.
Note: some of these functions are repeats of jQuery functions. Since we are not using jQuery, we wrote our own implementations.
| Name | Summary |
|---|---|
isF | Checks if argument is a function. |
isA | Checks if argument is an array. |
isS | Checks if argument is a string. |
isO | Checks if argument is an object. |
contains | Checks if an array contains a value. |
areFunctions | Checks if given strings are names of functions on an API and whether the API has functions that are not listed. |
areFunctionsNonStrict | Checks if given strings are names of functions on an API. (Doesn't care about unlisted functions.) |
windowSize | Returns inner dimensions of the window minus given values. |
isMobile | Returns true if the device viewing the GUI is a mobile device. |
debugOn | Returns true if the debug flag is turned on in query params. |
find | Searches through an array of objects looking for the one with the tagged property with a given key. |
inArray | Checks if an item is in the array. |
removeFromArray | Removes specified item from the array. |
isEmptyObject | Returns true if the object is empty. |
cap | Returns the string with only the first letter capitalized. |
noPx | Return the argument without the 'px' suffix. |
noPxStyle | Return the element's style property without the 'px' suffix. |
endsWith | Checks if the given string ends with a given suffix. |
parseBitRate | Returns a Number version of the given string bit rate. |
Function Descriptions
isF
Short for "is Function".
Example Usage
fs.isF(f);
Arguments
f - the variable to check if it is a function.
Return Value
Truthy: f if typeof is 'function'.
Falsy: null if f is not a function.
isA
Short for "is Array".
Example Usage
fs.isA(a);
Arguments
a - the variable to check if it is an array.
Return Value
Truthy: a if isArray (ECMA5) returns true.
Falsy: null if a is not an array.
isS
Short for "is String".
Example Usage
fs.isS(s);
Arguments
s - the variable to check if it is a string.
Return Value
Truthy: s if typeof is 'string'.
Falsy: null if s is not a string.
isO
Short for "is Object".
Example Usage
fs.isO(o);
Arguments
o - the variable to check if it is an object.
Return Value
Truthy: o if typeof is 'object' and the constructor is Object.
Falsy: null if o is not an object.
contains
Example Usage
fs.contains(a, x);
Arguments
a - the array to search
x - the item to look for
Return Value
Truthy: The index of the item you are looking for.
Falsy: False if a isn't an array, or -1 if x isn't in the array.