Class Validator<TValid>`Abstract`

The base class of all the validators in this package. TValid is the type of any value that passes validation.

Type Parameters

TValid

Hierarchy

Validator

Index

Constructors

Properties

cachedJsonSchema

Methods

_toJsonSchema checkValid isValid toJsonSchema validate

Constructors

constructor

new Validator<TValid>(): Validator<TValid>
Type Parameters
- TValid
Returns Validator<TValid>

Properties

`Private` cachedJsonSchema

cachedJsonSchema: undefined | JSONSchema7

Methods

`Protected` `Abstract` _toJsonSchema

_toJsonSchema(): JSONSchema7
Return the JSON schema for the given validator

Returns JSONSchema7
- Defined in src/interfaces.ts:66

checkValid

checkValid(value: unknown, path?: readonly (string | number)[]): TValid
Validate the given value and throw if it's not valid
Parameters
- value: unknown
  
  that is TValid
- Optional path: readonly (string | number)[]
  
  The path at which the value being checked was found
Returns TValid
- Defined in src/interfaces.ts:82

isValid

isValid(value: unknown): value is TValid
Return true if the value is valid. #isValid is unique in that validation errors are not surfaced, so the validator may optimize for performance.
Parameters
- value: unknown
  
  value to check
Returns value is TValid
- Defined in src/interfaces.ts:73

toJsonSchema

toJsonSchema(): JSONSchema7
Handles caching and removing undefined properties

Returns JSONSchema7
- Defined in src/interfaces.ts:56

`Abstract` validate

validate(value: unknown, path?: readonly (string | number)[]): ValidationError[]
Validate a given value with the assumed path, returning any errors
Parameters
- value: unknown
  
  value to validate
- Optional path: readonly (string | number)[]
  
  current path of the validation
Returns ValidationError[]
- Defined in src/interfaces.ts:46

Generated using TypeDoc