Class: Operation
Callable type representing a function that either reads or writes the state at a given path. When invoked, returns an instance of State.
Hierarchy
↳ Callable
↳ Operation
Index
Constructors
Properties
Methods
Constructors
constructor
+ new Operation(path: string, func: Function, args: object, isRead: boolean, isCacheable: boolean, dependents: any[], dependencies: any[]): Operation
Overrides Callable.constructor
Defined in lib/control/Operation.ts:20
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
path |
string | - | The path which the operation evaluates. Used to determine the resulting query. |
func |
Function | - | The function that will be invoked when the instance is invoked. |
args |
object | - | The arguments with which the func will be invoked and which will be used to construct the instance's query string. |
isRead |
boolean | - | Determines whether is the operation is a read or write. If the operation is a read, the path will be considered a {@linkcode Operation.dependency |
isCacheable |
boolean | - | See Operation.isCacheable. Note that this parameter can only be used to make a read operation non-cacheable, not to make a write operation cacheable. |
dependents |
any[] | [] | See Operation.dependents. |
dependencies |
any[] | [] | See Operation.dependencies. |
Returns: Operation
Properties
call
• call: Function
Defined in lib/utility/Callable.ts:6
The function that will be executed when the instance is invoked.
arguments
• arguments: any
Inherited from Callable.arguments
Defined in node_modules/typescript/lib/lib.es5.d.ts:302
caller
• caller: Function
Inherited from Callable.caller
Defined in node_modules/typescript/lib/lib.es5.d.ts:303
dependencies
• dependencies: Array‹string›
Defined in lib/control/Operation.ts:20
The paths upon which any State instance produced by invoking the operation will depend.
dependents
• dependents: Array‹string›
Defined in lib/control/Operation.ts:17
The paths which should be invalidated whenever the operation is invoked.
isCacheable
• isCacheable: boolean
Defined in lib/control/Operation.ts:14
Determines whether the operation may be cached.
Readonly length
• length: number
Inherited from Callable.length
Defined in node_modules/typescript/lib/lib.es5.d.ts:299
prototype
• prototype: any
Inherited from Callable.prototype
Defined in node_modules/typescript/lib/lib.es5.d.ts:298
query
• query: string
Defined in lib/control/Operation.ts:11
The query representing the operation.
Methods
apply
▸ apply(this: Function, thisArg: any, argArray?: any): any
Defined in node_modules/typescript/lib/lib.es5.d.ts:278
Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.
Parameters:
| Name | Type | Description |
|---|---|---|
this |
Function | - |
thisArg |
any | The object to be used as the this object. |
argArray? |
any | A set of arguments to be passed to the function. |
Returns: any
bind
▸ bind(this: Function, thisArg: any, ...argArray: any[]): any
Defined in node_modules/typescript/lib/lib.es5.d.ts:293
For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.
Parameters:
| Name | Type | Description |
|---|---|---|
this |
Function | - |
thisArg |
any | An object to which the this keyword can refer inside the new function. |
...argArray |
any[] | A list of arguments to be passed to the new function. |
Returns: any
call
▸ call(this: Function, thisArg: any, ...argArray: any[]): any
Defined in node_modules/typescript/lib/lib.es5.d.ts:285
Calls a method of an object, substituting another object for the current object.
Parameters:
| Name | Type | Description |
|---|---|---|
this |
Function | - |
thisArg |
any | The object to be used as the current object. |
...argArray |
any[] | A list of arguments to be passed to the method. |
Returns: any
toString
▸ toString(): string
Inherited from Callable.toString
Defined in node_modules/typescript/lib/lib.es5.d.ts:296
Returns a string representation of a function.
Returns: string