Class SchemaBuilder<TResult, TRequired>`Abstract`

Base class for all schema builders. Provides basic functionality for schema building.

Note: this class is not intended to be used directly, use one of the subclasses instead.

Typeparam

TResult Type of the object that will be returned by validate() method.

Typeparam

TRequired If true, object will be required. If false, object will be optional.

Type Parameters

TResult = any
TRequired extends boolean = true

Hierarchy

SchemaBuilder

Index

Constructors

`Protected` constructor

new SchemaBuilder<TResult, TRequired>(props): SchemaBuilder<TResult, TRequired>
Type Parameters
- TResult = any
- TRequired extends boolean = true
Parameters
- props: SchemaBuilderProps<TResult>
Returns SchemaBuilder<TResult, TRequired>
- Defined in builders/SchemaBuilder.ts:409

Accessors

`Protected` isRequired

get isRequired(): TRequired
Returns TRequired
- Defined in builders/SchemaBuilder.ts:137
set isRequired(value): void
Parameters
- value: boolean
Returns void
- Defined in builders/SchemaBuilder.ts:141

`Protected` preprocessors

get preprocessors(): Preprocessor<TResult>[]
A list of preprocessors associated with the Builder

Returns Preprocessor<TResult>[]
- Defined in builders/SchemaBuilder.ts:125

`Protected` type

get type(): string
Returns string
- Defined in builders/SchemaBuilder.ts:111
set type(value): void
Parameters
- value: string
Returns void
- Defined in builders/SchemaBuilder.ts:115

`Protected` validators

get validators(): Validator<TResult>[]
A list of validators associated with the Builder

Returns Validator<TResult>[]
- Defined in builders/SchemaBuilder.ts:133

Methods

addPreprocessor

addPreprocessor(preprocessor): SchemaBuilder<TResult, TRequired>
Adds a preprocessor to a preprocessors list
Parameters
- preprocessor: Preprocessor<TResult>
Returns SchemaBuilder<TResult, TRequired>
- Defined in builders/SchemaBuilder.ts:352

addValidator

addValidator(validator): SchemaBuilder<TResult, TRequired>
Adds a validator to validators list.
Parameters
- validator: Validator<TResult>
Returns SchemaBuilder<TResult, TRequired>
- Defined in builders/SchemaBuilder.ts:375

`Abstract` clearHasType

clearHasType(): any
Clears type set by call to .hasType<T>(), default schema type inference will be used for schema retuned by this call.

Returns any
- Defined in builders/SchemaBuilder.ts:101

clearPreprocessors

clearPreprocessors(): SchemaBuilder<TResult, TRequired>
Remove all preprocessors for this schema.

Returns SchemaBuilder<TResult, TRequired>
- Defined in builders/SchemaBuilder.ts:365

clearValidators

clearValidators(): SchemaBuilder<TResult, TRequired>
Remove all validators for this schema.

Returns SchemaBuilder<TResult, TRequired>
- Defined in builders/SchemaBuilder.ts:388

`Protected` `Abstract` createFromProps

createFromProps(props): SchemaBuilder<TResult, TRequired>
Protected method used to create an new instance of the Builder defined by the props object. Should be used to instanticate new builders to keep builder's immutability.
Parameters
- props: any
  
  arbitrary props object
Returns SchemaBuilder<TResult, TRequired>
- Defined in builders/SchemaBuilder.ts:109

`Abstract` hasType

hasType<T>(notUsed?): any
Set type of schema explicitly. notUsed param is needed only for cas when JS is used. E.g. when you can't call method like schema.hasType<Date>(), so instead you can call schema.hasType(new Date()) with the same result.
Type Parameters
- T
Parameters
- Optional notUsed: T
Returns any
- Defined in builders/SchemaBuilder.ts:95

introspect

introspect(): {
    isRequired: boolean;
    preprocessors: readonly Preprocessor<TResult>[];
    type: string;
    validators: readonly Validator<TResult>[];
}
Generates a serializable object describing the defined schema

Returns {
    isRequired: boolean;
    preprocessors: readonly Preprocessor<TResult>[];
    type: string;
    validators: readonly Validator<TResult>[];
}
- isRequired: boolean
  
  If set to false, schema will be optional (null or undefined values will be considered as valid).
- preprocessors: readonly Preprocessor<TResult>[]
  
  Array of preprocessor functions
- type: string
  
  String id of schema type, e.g. string', numberorobject`.
- validators: readonly Validator<TResult>[]
  
  Array of validator functions
- Defined in builders/SchemaBuilder.ts:305

optional

optional(): any
Makes schema optional (consider null and undefined as valid objects for this schema)

Returns any
- Defined in builders/SchemaBuilder.ts:332

`Protected` preValidate

preValidate(object, context?): Promise<PreValidationResult<any, {
validatedObject: any;
}>>
Parameters
- object: any
  
  Object to validate
- Optional context: ValidationContext
Returns Promise<PreValidationResult<any, {
validatedObject: any;
}>>
- Defined in builders/SchemaBuilder.ts:147

required

required(): any
Makes schema required (consider null and undefined as invalid objects for this schema)

Returns any
- Defined in builders/SchemaBuilder.ts:342

`Abstract` validate

validate(object, context?): Promise<ValidationResult<any>>
Perform schema validation on object.
Parameters
- object: any
  
  Object to validate
- Optional context: ValidationContext
  
  Optional ValidationContext settings
Returns Promise<ValidationResult<any>>
- Defined in builders/SchemaBuilder.ts:398

Class SchemaBuilder<TResult, TRequired>Abstract

Typeparam

Typeparam

Type Parameters

TResult = any

TRequired extends boolean = true

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

Protected constructor

Type Parameters

TResult = any

TRequired extends boolean = true

Parameters

props: SchemaBuilderProps<TResult>

Returns SchemaBuilder<TResult, TRequired>

Accessors

Protected isRequired

Returns TRequired

Parameters

value: boolean

Returns void

Protected preprocessors

Returns Preprocessor<TResult>[]

Protected type

Returns string

Parameters

value: string

Returns void

Protected validators

Returns Validator<TResult>[]

Methods

addPreprocessor

Parameters

preprocessor: Preprocessor<TResult>

Returns SchemaBuilder<TResult, TRequired>

addValidator

Parameters

validator: Validator<TResult>

Returns SchemaBuilder<TResult, TRequired>

Abstract clearHasType

Returns any

clearPreprocessors

Returns SchemaBuilder<TResult, TRequired>

clearValidators

Returns SchemaBuilder<TResult, TRequired>

Protected Abstract createFromProps

Parameters

props: any

Returns SchemaBuilder<TResult, TRequired>

Abstract hasType

Type Parameters

T

Parameters

Optional notUsed: T

Returns any

introspect

Returns { isRequired: boolean; preprocessors: readonly Preprocessor<TResult>[]; type: string; validators: readonly Validator<TResult>[]; }

isRequired: boolean

preprocessors: readonly Preprocessor<TResult>[]

type: string

validators: readonly Validator<TResult>[]

optional

Returns any

Protected preValidate

Parameters

object: any

Optional context: ValidationContext

Returns Promise<PreValidationResult<any, { validatedObject: any; }>>

required

Returns any

Abstract validate

Parameters

object: any

Optional context: ValidationContext

Returns Promise<ValidationResult<any>>

Settings

Class SchemaBuilder<TResult, TRequired>`Abstract`

`Protected` constructor

`Protected` isRequired

`Protected` preprocessors

`Protected` type

`Protected` validators

`Abstract` clearHasType

`Protected` `Abstract` createFromProps

`Abstract` hasType

`Optional` notUsed: T

Returns {
isRequired: boolean;
preprocessors: readonly Preprocessor<TResult>[];
type: string;
validators: readonly Validator<TResult>[];
}

`Protected` preValidate

`Optional` context: ValidationContext

Returns Promise<PreValidationResult<any, {
validatedObject: any;
}>>

`Abstract` validate

`Optional` context: ValidationContext