@terascope/job-components / interfaces/operations

interfaces/operations

Index

Interfaces

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

Type Aliases

CrossValidationFn()

CrossValidationFn: (job, sysconfig) => void

Parameters

Parameter	Type
job	ValidatedJobConfig
sysconfig	SysConfig

Returns

void

Source

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

---

OpAPI

OpAPI: OpAPIFn | OpAPIInstance

Source

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

---

OpAPIFn()

OpAPIFn: (...args) => any

Parameters

Parameter	Type
...args	any[]

Returns

any

Source

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

---

OpAPIInstance

OpAPIInstance: object

Index signature

[method: string]: OpAPIFn | any

Source

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

---

ProcessorFn()<T>

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

Type parameters

Type parameter
T

Parameters

Parameter	Type
data	T
logger	Logger
sliceRequest	SliceRequest

Returns

Promise<T> | T

Source

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

---

ReaderFn()<T>

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

Type parameters

Type parameter
T

Parameters

Parameter	Type
sliceRequest	SliceRequest
logger	Logger

Returns

Promise<T> | T

Source

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

---

SelfValidationFn()

SelfValidationFn: (config) => void

Parameters

Parameter	Type
config	OpConfig

Returns

void

Source

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

---

SlicerFns

SlicerFns: SlicerFn[]

Source

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

---

SlicerResult

SlicerResult: Slice | SliceRequest | SliceRequest[] | null

Source

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

Variables

sliceAnalyticsMetrics

const sliceAnalyticsMetrics: readonly keyof SliceAnalyticsData[]

Source

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