Skip to main content

@terascope/job-components / config-validators

config-validators

Functions

validateAPIConfig()

validateAPIConfig<T>(inputSchema, inputConfig): APIConfig & T

Defined in: job-components/src/config-validators.ts:26

Merges the provided inputSchema with commonSchema and then validates the provided apiConfig against the resulting schema.

Type Parameters

Type Parameter
T

Parameters

ParameterType
inputSchemaTF.Schema<any>
inputConfigRecord<string, any>

Returns

APIConfig & T


validateJobConfig()

validateJobConfig<T>(inputSchema, inputConfig): ValidatedJobConfig & T

Defined in: job-components/src/config-validators.ts:43

Merges the provided inputSchema with commonSchema and then validates the provided jobConfig against the resulting schema.

Type Parameters

Type Parameter
T

Parameters

ParameterType
inputSchemaTF.Schema<any>
inputConfigRecord<string, any>

Returns

ValidatedJobConfig & T


validateOpConfig()

validateOpConfig<T>(inputSchema, inputConfig): OpConfig & T

Defined in: job-components/src/config-validators.ts:10

Merges the provided inputSchema with commonSchema and then validates the provided opConfig against the resulting schema.

Type Parameters

Type Parameter
T

Parameters

ParameterType
inputSchemaTF.Schema<any>
inputConfigRecord<string, any>

Returns

OpConfig & T