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.
This page is a work in progress.
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
Note: Green Text means that the return value is truthy. Red Text means that the return value is falsy.
isF
Short for "is Function". Checks if argument is a function.
| Example Usage | Arguments | Return Values |
|---|---|---|
fs.isF(f); | f - the variable to check if it is a function |
|
isA
Short for "is Array". Checks if argument is an array.
| Example Usage | Arguments | Return Values |
|---|---|---|
fs.isA(a); | a - the variable to check if it is an array |
|
isS
Short for "is String". Checks if argument is a string.
| Example Usage | Arguments | Return Values |
|---|---|---|
fs.isS(s); | s - the variable to check if it is a string |
|
isO
Short for "is Object". Checks if argument is an object.
| Example Usage | Arguments | Return Values |
|---|---|---|
fs.isO(o); | o - the variable to check if it is an object |
|
contains
Checks if an array contains an item.
| Example Usage | Arguments | Return Values |
|---|---|---|
fs.contains(a, x); |
| the index of false if -1 if |
areFunctions
areFunctionsNonStrict
windowSize
Returns inner dimensions of the browser window minus given values.
| Example Usage | Arguments | Default Params | Return Value |
|---|---|---|---|
fs.windowSize(offH, offW); |
|
| an object with members:
|
isMobile
Returns true if the device viewing the GUI is a mobile device.
| Example Usage | Arguments | Return Values |
|---|---|---|
| fs.isMobile(); | none | true if the device viewing the GUI is a mobile device false otherwise |
debugOn
Returns true if the debug flag is turned on in query params.
| Example Usage | Arguments | Return Values |
|---|---|---|
fs.debugOn(tag); | tag: string of which debug flag you are looking for | true if debug flag is turned on for
|