Job Components: `Execution Context Base Default`
execution-context/base.default
A base class for an Execution Context
Type parameters
Name | Type |
---|---|
T | extends OperationLifeCycle |
Hierarchy
default
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new default<T
>(config
, loggerName
): default
<T
>
Type parameters
Name | Type |
---|---|
T | extends OperationLifeCycle |
Parameters
Name | Type |
---|---|
config | ExecutionContextConfig |
loggerName | string |
Returns
default
<T
>
Defined in
packages/job-components/src/execution-context/base.ts:34
Properties
_loader
• Protected
Readonly
_loader: OperationLoader
Defined in
packages/job-components/src/execution-context/base.ts:28
_methodRegistry
• Protected
_methodRegistry: Map
<keyof T
, Set
<number
>>
Defined in
packages/job-components/src/execution-context/base.ts:30
_operations
• Protected
Readonly
_operations: Set
<T
>
Defined in
packages/job-components/src/execution-context/base.ts:29
assetIds
• Readonly
assetIds: string
[] = []
Defined in
packages/job-components/src/execution-context/base.ts:18
config
• Readonly
config: ExecutionConfig
Defined in
packages/job-components/src/execution-context/base.ts:15
context
• Readonly
context: WorkerContext
Defined in
packages/job-components/src/execution-context/base.ts:16
events
• Readonly
events: EventEmitter
The terafoundation EventEmitter
Defined in
packages/job-components/src/execution-context/base.ts:24
exId
• Readonly
exId: string
Defined in
packages/job-components/src/execution-context/base.ts:20
jobId
• Readonly
jobId: string
Defined in
packages/job-components/src/execution-context/base.ts:21
logger
• Readonly
logger: Logger
Defined in
packages/job-components/src/execution-context/base.ts:26
Accessors
api
• get
api(): ExecutionContextAPI
Returns
Defined in
packages/job-components/src/execution-context/base.ts:125
Methods
_resetMethodRegistry
▸ _resetMethodRegistry(): void
Returns
void
Defined in
packages/job-components/src/execution-context/base.ts:177
_runMethod
▸ _runMethod(method
, ...args
): void
Run an method
Parameters
Name | Type |
---|---|
method | keyof T |
...args | any [] |
Returns
void
Defined in
packages/job-components/src/execution-context/base.ts:163
_runMethodAsync
▸ _runMethodAsync(method
, ...args
): Promise
<any
[]>
Run an async method on the operation lifecycle
Parameters
Name | Type |
---|---|
method | keyof T |
...args | any [] |
Returns
Promise
<any
[]>
Defined in
packages/job-components/src/execution-context/base.ts:145
addOperation
▸ addOperation(op
): void
Add an operation to the lifecycle queue
Parameters
Name | Type |
---|---|
op | T |
Returns
void
Defined in
packages/job-components/src/execution-context/base.ts:138
getOperations
▸ getOperations(): T
[]
Returns a list of any registered Operation that has been initialized.
Returns
T
[]
Defined in
packages/job-components/src/execution-context/base.ts:133
initialize
▸ initialize(initConfig?
): Promise
<void
>
Called to initialize all of the registered operations
Parameters
Name | Type |
---|---|
initConfig? | unknown |
Returns
Promise
<void
>
Defined in
packages/job-components/src/execution-context/base.ts:64
shutdown
▸ shutdown(): Promise
<void
>
Called to cleanup all of the registered operations
Returns
Promise
<void
>