Skip to main content

@terascope/job-components / builtin/test-reader/schema / default

Class: default

A base class for supporting convict "Schema" definitions

Extends

Constructors

new default()

new default(context, opType): default

Parameters

ParameterTypeDefault value
contextContextundefined
opTypeOpType'operation'

Returns

default

Inherited from

default.constructor

Source

packages/job-components/src/operations/convict-schema.ts:21

Properties

context

protected context: Context

Inherited from

default.context

Source

packages/job-components/src/operations/core/schema-core.ts:8


opType

readonly opType: OpType

Inherited from

default.opType

Source

packages/job-components/src/operations/core/schema-core.ts:9


schema

schema: Schema<any>

Inherited from

default.schema

Source

packages/job-components/src/operations/convict-schema.ts:19

Methods

build()

build(): Record<string, any>

Returns

Record<string, any>

Overrides

default.build

Source

packages/job-components/src/builtin/test-reader/schema.ts:5


ensureAPIFromConfig()

ensureAPIFromConfig(apiName, job, config): void

This method will make sure that the api exists on the job, if it does not then it will inject it using apiName provided and with the config key/values provided. If the api does exist it will compare the apiConfig against the provided config. If the key/values do not match, then it will throw

Parameters

ParameterType
apiNamestring
jobValidatedJobConfig
configRecord<string, any>

Returns

void

Inherited from

default.ensureAPIFromConfig

Example

const job = newTestJobConfig({
operations: [
{ _op: 'test-reader' },
{ _op: 'noop' },
]
});

schema.ensureAPIFromConfig('someApi', job, { some: 'configs' });

job === {
apis: [{ _name: 'someApi', some: 'configs' }],
operations: [
{ _op: 'test-reader' },
{ _op: 'noop' },
]
}

Source

packages/job-components/src/operations/convict-schema.ts:65


validate()

validate(inputConfig)

validate(inputConfig): APIConfig & TestReaderConfig

Parameters
ParameterType
inputConfigRecord<string, any>
Returns

APIConfig & TestReaderConfig

Inherited from

default.validate

Source

packages/job-components/src/operations/convict-schema.ts:26

validate(inputConfig)

validate(inputConfig): OpConfig & TestReaderConfig

Parameters
ParameterType
inputConfigRecord<string, any>
Returns

OpConfig & TestReaderConfig

Inherited from

default.validate

Source

packages/job-components/src/operations/convict-schema.ts:27


validateJob()

validateJob(_job): void

Parameters

ParameterType
_jobValidatedJobConfig

Returns

void

Inherited from

default.validateJob

Source

packages/job-components/src/operations/convict-schema.ts:36


type()

static type(): string

Returns

string

Inherited from

default.type

Source

packages/job-components/src/operations/convict-schema.ts:98