Functions
- areCompatibleDataTypes
- assign
- assignDeep
- combinePath
- findItemById
- generateId
- indexOfArrayItem
- isIntType
- isNumeric
- isNumericType
- isObject
- isPropSet
- linkTypeToStr
- moveArrayItem
- parseOperatorFormat
- removeArrayItem
- shiftToFitWindow
- strToLinkType
areCompatibleDataTypes
Section titled “areCompatibleDataTypes”Returns true if two data types passed in parameters
are compatible - so it’s safe to copy the values between
two expressions with these two types
▸ areCompatibleDataTypes(type1: DataType,type2: DataType): boolean
Parameters:
Section titled “Parameters:”Returns boolean
assign
Section titled “assign”Copy the content of all objests passed in args parameters into target
and returns the result
NB: This function copies only the first level properties.
For a deep copy please use assignDeep
▸ assign(target: any,args: any[]): any
Parameters:
Section titled “Parameters:”- target:
any- the target object - args:
any[] - an array of the source objects
Returns any
assignDeep
Section titled “assignDeep”Copy the content of all objests passed in args parameters into target
and returns the result
NB: This function make a deep copy -
so assignDeep will be called recursively for all object properties
on the first level.
▸ assignDeep(target: any,args: any[]): any
Parameters:
Section titled “Parameters:”- target:
any- the target object - args:
any[] - an array of the source objects
Returns any
combinePath
Section titled “combinePath”Adds two paths and returns the result Correctly processes leading and trailing slashes
▸ combinePath(path1: string,path2: string): string
Parameters:
Section titled “Parameters:”- path1:
string - path2:
string-
Returns string
findItemById
Section titled “findItemById”Searches an array of the objects which implement ItemWithId by ID Returs the found object or null.
▸ findItemById(array: Array<T>,id: any): T
Parameters:
Section titled “Parameters:”- array:
Array<T> - id:
any-
Returns T
generateId
Section titled “generateId”Generates an unique ID
▸ generateId(): string
Returns string
indexOfArrayItem
Section titled “indexOfArrayItem”Searches an array of the objects which implement ItemWithId by ID Returs the index of the found element, or -1 if nothing was found.
▸ indexOfArrayItem(arr: Array<T>,item: T): number
Parameters:
Section titled “Parameters:”- arr:
Array<T> - item:
T
Returns number
isIntType
Section titled “isIntType”Returns true if the DataType value passed in the parameter
represents some numeric type
▸ isIntType(dtype: DataType): boolean
Parameters:
Section titled “Parameters:”- dtype: DataType -
Returns boolean
isNumeric
Section titled “isNumeric”Returns true if the value passed in the parameter is an a numeric value
▸ isNumeric(val: any): boolean
Parameters:
Section titled “Parameters:”- val:
any-
Returns boolean
isNumericType
Section titled “isNumericType”Returns true if the DataType value passed in the parameter
represents some numeric type
▸ isNumericType(dtype: DataType): boolean
Parameters:
Section titled “Parameters:”- dtype: DataType -
Returns boolean
isObject
Section titled “isObject”Returns true if the value passed in the parameter is an object
▸ isObject(val: any): boolean
Parameters:
Section titled “Parameters:”- val:
any-
Returns boolean
isPropSet
Section titled “isPropSet”Returns true if the property with named propName
in the object obj has some value
▸ isPropSet(obj: any,propName: any): any
Parameters:
Section titled “Parameters:”- obj:
any - propName:
any-
Returns any
linkTypeToStr
Section titled “linkTypeToStr”Converts a LinkType value to a string
▸ linkTypeToStr(type: LinkType): string
Parameters:
Section titled “Parameters:”- type: LinkType -
Returns string
moveArrayItem
Section titled “moveArrayItem”Moves an item in some array to a new position
▸ moveArrayItem(arr: Array<T>,old_index: number,new_index: number): void
Parameters:
Section titled “Parameters:”- arr:
Array<T> - old_index:
number - new_index:
number-
Returns void
parseOperatorFormat
Section titled “parseOperatorFormat”Parses the operator’s format string and returns a list of tokens
▸ parseOperatorFormat(operator: any): FormatToken[]
Parameters:
Section titled “Parameters:”- operator:
any-
Returns FormatToken[]
removeArrayItem
Section titled “removeArrayItem”Searches for a particular item in the array are removes that item if found.
▸ removeArrayItem(arr: Array<T>,value: T): T
Parameters:
Section titled “Parameters:”- arr:
Array<T> - value:
T-
Returns T
shiftToFitWindow
Section titled “shiftToFitWindow”Calculates the shift on which we need to move our element horizontally to find current window
▸ shiftToFitWindow(absLeft: number,width: number): number
Parameters:
Section titled “Parameters:”- absLeft:
number - width:
number-
Returns number
strToLinkType
Section titled “strToLinkType”Converts a string to a LinkType value
▸ strToLinkType(str: string): LinkType
Parameters:
Section titled “Parameters:”- str:
string-
Returns LinkType