Skip to main content

@terascope/job-components / interfaces/operations

interfaces/operations

Interfaces​

InterfaceDescription
ExecutionStats-
SliceResult-
SlicerFn-
SlicerRecoveryDataThe metadata given to Slicer after successfully recovering the execution

Type Aliases​

CrossValidationFn​

CrossValidationFn = (job, sysconfig) => void

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

Parameters​

ParameterType
jobValidatedJobConfig
sysconfigSysConfig

Returns​

void


OpAPI​

OpAPI = OpAPIFn | OpAPIInstance

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


OpAPIFn​

OpAPIFn = (...args) => any

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

Parameters​

ParameterType
...argsany[]

Returns​

any


OpAPIInstance​

OpAPIInstance = object

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

Index Signature​

[method: string]: any


ProcessorFn​

ProcessorFn<T> = (data, logger, sliceRequest) => Promise<T> | T

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

Type Parameters​

Type Parameter
T

Parameters​

ParameterType
dataT
loggerLogger
sliceRequestSliceRequest

Returns​

Promise<T> | T


ReaderFn​

ReaderFn<T> = (sliceRequest, logger) => Promise<T> | T

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

Type Parameters​

Type Parameter
T

Parameters​

ParameterType
sliceRequestSliceRequest
loggerLogger

Returns​

Promise<T> | T


SelfValidationFn​

SelfValidationFn = (config) => void

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

Parameters​

ParameterType
configOpConfig

Returns​

void


SlicerFns​

SlicerFns = SlicerFn[]

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


SlicerResult​

SlicerResult = Slice | SliceRequest | SliceRequest[] | null

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

Variables​

sliceAnalyticsMetrics​

const sliceAnalyticsMetrics: readonly keyof SliceAnalyticsData[]

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