@terascope/job-components / execution-context/base / default
Class: default<T>
Defined in: job-components/src/execution-context/base.ts:16
A base class for an Execution Context
Extended by
Type Parameters
| Type Parameter |
|---|
T extends OperationLifeCycle |
Constructors
Constructor
new default<
T>(config,loggerName):BaseExecutionContext<T>
Defined in: job-components/src/execution-context/base.ts:36
Parameters
| Parameter | Type |
|---|---|
config | ExecutionContextConfig |
loggerName | string |
Returns
BaseExecutionContext<T>
Properties
| Property | Modifier | Type | Default value | Description | Defined in |
|---|---|---|---|---|---|
_loader | readonly | OperationLoader | undefined | - | job-components/src/execution-context/base.ts:30 |
_methodRegistry | protected | Map<keyof T, Set<number>> | undefined | - | job-components/src/execution-context/base.ts:32 |
_operations | readonly | Set<T> | undefined | - | job-components/src/execution-context/base.ts:31 |
assetIds | readonly | string[] | [] | - | job-components/src/execution-context/base.ts:20 |
config | readonly | ExecutionConfig | undefined | - | job-components/src/execution-context/base.ts:17 |
context | readonly | Context | undefined | - | job-components/src/execution-context/base.ts:18 |
events | readonly | EventEmitter | undefined | The terafoundation EventEmitter | job-components/src/execution-context/base.ts:26 |
exId | readonly | string | undefined | - | job-components/src/execution-context/base.ts:22 |
jobId | readonly | string | undefined | - | job-components/src/execution-context/base.ts:23 |
logger | readonly | Logger | undefined | - | job-components/src/execution-context/base.ts:28 |
Accessors
api
Get Signature
get api():
ExecutionContextAPI
Defined in: job-components/src/execution-context/base.ts:130
Returns
Methods
_resetMethodRegistry()
protected_resetMethodRegistry():void
Defined in: job-components/src/execution-context/base.ts:182
Returns
void
_runMethod()
protected_runMethod(method, ...args):void
Defined in: job-components/src/execution-context/base.ts:168
Run an method
Parameters
| Parameter | Type |
|---|---|
method | keyof T |
...args | any[] |
Returns
void
_runMethodAsync()
protected_runMethodAsync(method, ...args):Promise<any[]>
Defined in: job-components/src/execution-context/base.ts:150
Run an async method on the operation lifecycle
Parameters
| Parameter | Type |
|---|---|
method | keyof T |
...args | any[] |
Returns
Promise<any[]>
addOperation()
protectedaddOperation(op):void
Defined in: job-components/src/execution-context/base.ts:143
Add an operation to the lifecycle queue
Parameters
| Parameter | Type |
|---|---|
op | T |
Returns
void
getOperations()
getOperations():
T[]
Defined in: job-components/src/execution-context/base.ts:138
Returns a list of any registered Operation that has been initialized.
Returns
T[]
initialize()
initialize(
initConfig?):Promise<void>
Defined in: job-components/src/execution-context/base.ts:66
Called to initialize all of the registered operations
Parameters
| Parameter | Type |
|---|---|
initConfig? | unknown |
Returns
Promise<void>
shutdown()
shutdown():
Promise<void>
Defined in: job-components/src/execution-context/base.ts:103
Called to cleanup all of the registered operations
Returns
Promise<void>