@terascope/job-components / interfaces/operations

interfaces/operations

Interfaces

Interface	Description
ExecutionStats	-
SliceResult	-
SlicerFn	-
SlicerRecoveryData	The metadata given to Slicer after successfully recovering the execution

Type Aliases

CrossValidationFn()

CrossValidationFn = (job, sysconfig) => void

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

Parameters

Parameter	Type
job	ValidatedJobConfig
sysconfig	SysConfig

Returns

void

---

OpAPI

OpAPI = OpAPIFn | OpAPIInstance

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

---

OpAPIFn()

OpAPIFn = (...args) => any

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

Parameters

Parameter	Type
...args	any[]

Returns

any

---

OpAPIInstance

OpAPIInstance = object

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

Index Signature

[method: string]: any

---

ProcessorFn()<T>

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

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

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
data	T
logger	Logger
sliceRequest	SliceRequest

Returns

Promise<T> | T

---

ReaderFn()<T>

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

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

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
sliceRequest	SliceRequest
logger	Logger

Returns

Promise<T> | T

---

SelfValidationFn()

SelfValidationFn = (config) => void

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

Parameters

Parameter	Type
config	OpConfig

Returns

void

---

SlicerFns

SlicerFns = SlicerFn[]

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

---

SlicerResult

SlicerResult = Slice | SliceRequest | SliceRequest[] | null

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

Variables

sliceAnalyticsMetrics

const sliceAnalyticsMetrics: readonly keyof SliceAnalyticsData[]

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