Members
-
Parent :*
-
The parent of the event instance.
Type:
- *
- Source:
-
Cancellable :boolean
-
Specifies that eventObjects passed to handlers of this event will be cancellable.
Type:
- boolean
- Default Value:
-
- {false}
- Source:
-
ReturnAllResults :boolean
-
When set to true the caller of the event will receive all handler return values in an array instead of just the most recent return value.
Type:
- boolean
- Default Value:
-
- {false}
- Source:
-
Stoppable :boolean
-
Specifies that eventObjects passed to handlers of this event will be stoppable.
Type:
- boolean
- Default Value:
-
- {true}
- Source:
-
SyncWhenAsync :boolean
-
Event handlers will be called in sequence even when called asynchronously.
Type:
- boolean
- Default Value:
-
- {true}
- Source:
-
Queue :Array.<Event#EventObject>
-
Queue asynchronous event calls to execute handlers in order of events when an array is specified for the queue.
Type:
- Array.<Event#EventObject>
- Default Value:
-
- {null}
- Source:
Methods
-
ContainsMember()
-
Returns:
- Type
- boolean
-
FirstMember()
-
Returns:
- Type
- undefined
-
traverseObjectsAndArrays(node, func [, parent])
-
Object extension utilized for traversing objects within objects.
Parameters:
Name Type Argument Description node
* func
Object~traverseObjectsAndArraysCallback parent
* <optional>
-
CountMembers()
-
Returns:
- Type
- number
-
traverseObjectsAndArrayElements(node, func [, parent])
-
Object extension utilized for traversing objects within objects along with array elements.
Parameters:
Name Type Argument Description node
* func
Object~traverseObjectsAndArrayElementsCallback parent
* <optional>
-
traverseObjects(node, func [, parent])
-
Object extension utilized for traversing objects within objects.
Parameters:
Name Type Argument Description node
* func
Object~traverseObjectsCallback parent
* <optional>
-
traverse(node, func [, parent])
-
Object extension utilized for traversing all elements within objects.
Parameters:
Name Type Argument Description node
* func
Object~traverseCallback parent
* <optional>
-
subtract(a, b)
-
Object extension utilized for boolean-like subtraction of objects.
Parameters:
Name Type Description a
* Object to be subtracted from.
b
* Object to be subtracted.
Returns:
- Type
- *
-
shallowReplace(node, find, replacement)
-
Object extension utilized for replacing values within objects.
Parameters:
Name Type Description node
* find
* replacement
* -
shallowMerge(a, b)
-
Object extension utilized for merging of objects at the root level, equivalent to a logical OR.
Parameters:
Name Type Description a
* Base Object for merge operation.
b
* Object to be merged into base Object.
Returns:
- Type
- *
-
shallowMatchOrderAgnostic(a, b)
-
Object extension utilized for shallow matching of objects, in an order-agnostic manner within the context of Arrays.
Parameters:
Name Type Description a
* Object to be matched against.
b
* Object to be matched.
Returns:
- Type
- boolean
-
shallowMatch(a, b)
-
Object extension utilized for shallow matching of objects.
Parameters:
Name Type Description a
* Object to be matched against.
b
* Object to be matched.
Returns:
- Type
- boolean
-
shallowIntersectionOrderAgnostic(a, b)
-
Object extension utilized for retrieving the intersection of objects at the root level in an order agnostic manner with respect to arrays, equivalent to a logical AND.
Parameters:
Name Type Description a
* First Object for intersection operation.
b
* Second Object for intersection operation.
Returns:
- Type
- *
-
shallowIntersection(a, b)
-
Object extension utilized for retrieving the intersection of objects at the root level, equivalent to a logical AND.
Parameters:
Name Type Description a
* First Object for intersection operation.
b
* Second Object for intersection operation.
Returns:
- Type
- *
-
shallowClone(obj)
-
Object extension utilized for shallow cloning of objects.
Parameters:
Name Type Description obj
* Object to be cloned.
Returns:
- Type
- *
-
shallowAssign(a, b)
-
Object extension utilized for assigning of objects at the root level.
Parameters:
Name Type Description a
* Base Object for assignment operation.
b
* Object to be assigned into base Object.
Returns:
- Type
- *
-
matchWeight(a, b [, state])
-
Object extension utilized for determining the match weight between objects.
Parameters:
Name Type Argument Description a
* Object to be matched against.
b
* Object to be matched.
state
Array <optional>
Internal state object.
Returns:
- Type
- boolean | number
-
isClass(obj)
-
Object extension utilized for determining whether or not an object is a class.
Parameters:
Name Type Description obj
* Object to be evaluated.
Returns:
- Type
- boolean
-
dumbReplace(node, find, replacement)
-
Object extension utilized for replacing values within objects recursively without safety checks.
Parameters:
Name Type Description node
* find
* replacement
* -
dumbMerge(a, b)
-
Object extension utilized for merging of objects by copying of values recursively without safety checks, equivalent to a logical OR.
Parameters:
Name Type Description a
* Base Object for merge operation.
b
* Object to be merged into base Object.
Returns:
- Type
- *
-
dumbMatchOrderAgnostic(a, b)
-
Object extension utilized for deep matching of objects without safety checks and in an order-agnostic manner within the context of Arrays.
Parameters:
Name Type Description a
* Object to be matched against.
b
* Object to be matched.
Returns:
- Type
- boolean
-
dumbMatch(a, b)
-
Object extension utilized for deep matching of objects without safety checks.
Parameters:
Name Type Description a
* Object to be matched against.
b
* Object to be matched.
Returns:
- Type
- boolean
-
dumbIntersection(a, b)
-
Object extension utilized for retrieving the intersection of objects recursively without safety checks, equivalent to a logical AND.
Parameters:
Name Type Description a
* Base Object for merge operation.
b
* Object to be merged into base Object.
Returns:
- Type
- *
-
dumbClone(obj)
-
Object extension utilized for deep cloning of objects without safety checks.
Parameters:
Name Type Description obj
* Object to be cloned.
Returns:
- Type
- *
-
dumbAssign(a, b)
-
Object extension utilized for assigning of objects by copying of values recursively without safety checks.
Parameters:
Name Type Description a
* Base Object for assignment operation.
b
* Object to be assigned into base Object.
Returns:
- Type
- *
-
deepReplace(node, find, replacement)
-
Object extension utilized for replacing values within objects recursively with safety checks.
Parameters:
Name Type Description node
* find
* replacement
* -
deepMerge(a, b [, state] [, cloneState])
-
Object extension utilized for merging of objects by copying of values recursively with safety checks, equivalent to a logical OR.
Parameters:
Name Type Argument Description a
* Base Object for merge operation.
b
* Object to be merged into base Object.
state
Array <optional>
Internal state object.
cloneState
Array <optional>
Internal state object utilized for deep clones.
Returns:
- Type
- *
-
deepMatchOrderAgnostic(a, b [, state])
-
Object extension utilized for deep matching of objects, in an order-agnostic manner within the context of Arrays.
Parameters:
Name Type Argument Description a
* Object to be matched against.
b
* Object to be matched.
state
Array <optional>
Internal state object.
Returns:
- Type
- boolean
-
deepMatch(a, b [, state])
-
Object extension utilized for deep matching of objects.
Parameters:
Name Type Argument Description a
* Object to be matched against.
b
* Object to be matched.
state
Array <optional>
Internal state object.
Returns:
- Type
- boolean
-
deepClone(obj [, state])
-
Object extension utilized for deep cloning of objects.
Parameters:
Name Type Argument Description obj
* Object to be cloned.
state
Array <optional>
Internal state object.
Returns:
- Type
- *
-
deepAssign(a, b [, state] [, cloneState])
-
Object extension utilized for assigning of objects by copying of values recursively without safety checks.
Parameters:
Name Type Argument Description a
* Base Object for assignment operation.
b
* Object to be assigned into base Object.
state
Array <optional>
Internal state object.
cloneState
Array <optional>
Internal state object utilized for deep clones.
Returns:
- Type
- *
-
countElements(obj)
-
Object extension utilized for counting of elements within objects.
Parameters:
Name Type Description obj
* Object to have elements counted.
Returns:
- Type
- *
-
possibleIndicesOf(arr, item)
-
Array extension utilized for determining the possible matched array indices of an item.
Parameters:
Name Type Description arr
* Array to be searched.
item
* Item to search for within the array.
Returns:
- Type
- *
-
bestIndicesOf(arr, item)
-
Array extension utilized for determining the best possible matched array indices of an item.
Parameters:
Name Type Description arr
* Array to be searched.
item
* Item to search for within the array.
Returns:
- Type
- *
-
bestIndexOf(arr, item)
-
Array extension utilized for determining the best matched array index of an item.
Parameters:
Name Type Description arr
* Array to be searched.
item
* Item to search for within the array.
Returns:
- Type
- *