@terascope/job-components / operations/core/api-core / default

Abstract Class: default<T>

Defined in: job-components/src/operations/core/api-core.ts:16

A base class for supporting APIs that run within an Execution Context.

Extends

• default<Context>

Extended by

• default
• default

Type Parameters

Type Parameter	Default type
T	APIConfig

Implements

• WorkerOperationLifeCycle
• SlicerOperationLifeCycle

Constructors

Constructor

new default<T>(context, apiConfig, executionConfig): APICore<T>

Defined in: job-components/src/operations/core/api-core.ts:23

Parameters

Parameter	Type
context	Context
apiConfig	APIConfig & T
executionConfig	ExecutionConfig

Returns

APICore<T>

Overrides

default.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
apiConfig	readonly	Readonly<APIConfig & T>	-	job-components/src/operations/core/api-core.ts:20
context	readonly	Readonly<T>	default.context	job-components/src/operations/core/core.ts:10
deadLetterAction	public	string	-	job-components/src/operations/core/api-core.ts:21
events	readonly	EventEmitter	default.events	job-components/src/operations/core/core.ts:13
executionConfig	readonly	Readonly<ExecutionConfig>	default.executionConfig	job-components/src/operations/core/core.ts:11
logger	readonly	Logger	default.logger	job-components/src/operations/core/core.ts:12

Methods

initialize()

initialize(): Promise<void>

Defined in: job-components/src/operations/core/api-core.ts:38

Called during execution initialization, when this is called perform any async setup.

Returns

Promise<void>

Implementation of

SlicerOperationLifeCycle.initialize

Overrides

default.initialize

---

rejectRecord()

rejectRecord(input, err): null

Defined in: job-components/src/operations/core/api-core.ts:80

Reject a record using the dead letter action

Based on OpConfig._dead_letter_action the transformation can be handled any of the following ways:

• "throw": throw the original error
• "log": log the error and the data
• "none": skip the error entirely OR a string to specify the api to use as the dead letter queue

Parameters

Parameter	Type
input	unknown
err	Error

Returns

null

null

---

shutdown()

shutdown(): Promise<void>

Defined in: job-components/src/operations/core/api-core.ts:42

Called during execution shutdown, when this is cleanup any open connections or destroy any in-memory state.

Returns

Promise<void>

Implementation of

SlicerOperationLifeCycle.shutdown

Overrides

default.shutdown

---

tryRecord()

tryRecord<I, R>(fn): (input) => R | null

Defined in: job-components/src/operations/core/api-core.ts:55

Try catch a transformation on a record and place any failed records in a dead letter queue

See #rejectRecord for handling

Type Parameters

Type Parameter
I
R

Parameters

Parameter	Type	Description
fn	(input) => R	a function to transform the data with

Returns

a curried a function that will be called with the data and handle the dead letter action

(input) => R | null