@terascope/job-components / operations/base-schema / default

Abstract Class: default<T, S>

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

A base class for supporting convict style "Schema" definitions

Extends

• default<T>

Extended by

• default
• default
• default
• default

Type Parameters

Type Parameter	Default type
T extends Record<string, any>	-
S	any

Constructors

Constructor

new default<T, S>(context, opType?): BaseSchema<T, S>

Defined in: job-components/src/operations/base-schema.ts:17

Parameters

Parameter	Type	Default value
context	Context	undefined
opType	OpType	'operation'

Returns

BaseSchema<T, S>

Overrides

default.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
context	protected	Context	default.context	job-components/src/operations/core/schema-core.ts:9
opType	readonly	OpType	default.opType	job-components/src/operations/core/schema-core.ts:10
schema	public	Terafoundation.Schema<S>	-	job-components/src/operations/base-schema.ts:15

Methods

build()

abstract build<U>(context?): Terafoundation.Schema<S & U>

Defined in: job-components/src/operations/base-schema.ts:45

Type Parameters

Type Parameter	Default type
U	any

Parameters

Parameter	Type
context?	Context

Returns

Terafoundation.Schema<S & U>

Overrides

default.build

---

validate()

Call Signature

validate(inputConfig): object

Defined in: job-components/src/operations/base-schema.ts:22

Parameters

Parameter	Type
inputConfig	Record<string, any>

Returns

object

config

config: APIConfig & T

warnings

warnings: JobWarning[]

Overrides

default.validate

Call Signature

validate(inputConfig): object

Defined in: job-components/src/operations/base-schema.ts:25

Parameters

Parameter	Type
inputConfig	Record<string, any>

Returns

object

config

config: OpConfig & T

warnings

warnings: JobWarning[]

Overrides

SchemaCore.validate

---

validateJob()

validateJob(_job): void

Defined in: job-components/src/operations/base-schema.ts:37

Parameters

Parameter	Type
_job	ValidatedJobConfig

Returns

void

Overrides

default.validateJob

---

type()

static type(): string

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

Returns

string