Skip to main content

@terascope/job-components / operations/interfaces

operations/interfaces

Interfaces

InterfaceDescription
APIModule-
OperationModule-
ProcessorModule-
ReaderModule-
SchemaModule-

Type Aliases

APIConstructor

APIConstructor = APICoreConstructor<default>

Defined in: packages/job-components/src/operations/interfaces.ts:41


APICoreConstructor()<U>

APICoreConstructor<U> = (context, apiConfig, executionConfig) => U

Defined in: packages/job-components/src/operations/interfaces.ts:14

Type Parameters

Type Parameter
U

Parameters

ParameterType
contextContext
apiConfigAPIConfig
executionConfigExecutionConfig

Returns

U


CoreOperation

CoreOperation = default | default | default

Defined in: packages/job-components/src/operations/interfaces.ts:48


FetcherConstructor

FetcherConstructor = OperationCoreConstructor<default>

Defined in: packages/job-components/src/operations/interfaces.ts:45


ObserverConstructor

ObserverConstructor = APICoreConstructor<default>

Defined in: packages/job-components/src/operations/interfaces.ts:40


OperationAPIConstructor

OperationAPIConstructor = APICoreConstructor<default>

Defined in: packages/job-components/src/operations/interfaces.ts:39


OperationAPIType

OperationAPIType = "api" | "observer"

Defined in: packages/job-components/src/operations/interfaces.ts:59


OperationCoreConstructor()<U>

OperationCoreConstructor<U> = <T>(context, opConfig, executionConfig) => U

Defined in: packages/job-components/src/operations/interfaces.ts:18

Type Parameters

Type Parameter
U

Parameters

ParameterType
contextContext
opConfigOpConfig & T
executionConfigExecutionConfig

Returns

U


ParallelSlicerConstructor

ParallelSlicerConstructor = SlicerCoreConstructor<default>

Defined in: packages/job-components/src/operations/interfaces.ts:44


ProcessorConstructor

ProcessorConstructor = OperationCoreConstructor<default>

Defined in: packages/job-components/src/operations/interfaces.ts:46


SchemaConstructor()<T>

SchemaConstructor<T> = default<T>

Defined in: packages/job-components/src/operations/interfaces.ts:34

Type Parameters

Type ParameterDefault type
Tany

new SchemaConstructor(context, opType?): default<T>

Defined in: packages/job-components/src/operations/interfaces.ts:36

Parameters

ParameterType
contextContext
opType?OpType

Returns

default<T>

Methods

type()

type(): string

Defined in: packages/job-components/src/operations/interfaces.ts:35

Returns

string


SingleSlicerConstructor

SingleSlicerConstructor = SlicerCoreConstructor<default>

Defined in: packages/job-components/src/operations/interfaces.ts:43


SlicerConstructor

SlicerConstructor = SlicerCoreConstructor<default>

Defined in: packages/job-components/src/operations/interfaces.ts:42


SlicerCoreConstructor()<U>

SlicerCoreConstructor<U> = <T>(context, opConfig, executionConfig) => U

Defined in: packages/job-components/src/operations/interfaces.ts:26

Type Parameters

Type Parameter
U

Parameters

ParameterType
contextContext
opConfigOpConfig & T
executionConfigExecutionConfig

Returns

U