@terascope/job-components / execution-context/base / default
Class: default<T>
Defined in: packages/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
new default()
new default<
T
>(config
,loggerName
):default
<T
>
Defined in: packages/job-components/src/execution-context/base.ts:36
Parameters
Parameter | Type |
---|---|
config | ExecutionContextConfig |
loggerName | string |
Returns
default
<T
>
Properties
Accessors
api
Get Signature
get api():
ExecutionContextAPI
Defined in: packages/job-components/src/execution-context/base.ts:130
Returns
Methods
_resetMethodRegistry()
protected
_resetMethodRegistry():void
Defined in: packages/job-components/src/execution-context/base.ts:182
Returns
void
_runMethod()
protected
_runMethod(method
, ...args
):void
Defined in: packages/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: packages/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()
protected
addOperation(op
):void
Defined in: packages/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: packages/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: packages/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: packages/job-components/src/execution-context/base.ts:103
Called to cleanup all of the registered operations
Returns
Promise
<void
>