@orbit/validators

Enumerations

• StandardValidators

Interfaces

• ArrayValidationOptions
• DateValidationOptions
• NumberValidationOptions
• StringValidationOptions
• ValidationIssue
• ValidationOptions

Type aliases

ArrayValidationIssue

Ƭ ArrayValidationIssue: TypeIssue | MinItemsIssue | MaxItemsIssue

Defined in

array-validator.ts:25

---

ArrayValidator

Ƭ ArrayValidator: Validator<unknown[], ArrayValidationOptions, ArrayValidationIssue>

Defined in

array-validator.ts:32

---

BooleanValidationIssue

Ƭ BooleanValidationIssue: TypeIssue

Defined in

boolean-validator.ts:11

---

BooleanValidator

Ƭ BooleanValidator: Validator<boolean, undefined, BooleanValidationIssue>

Defined in

boolean-validator.ts:13

---

DateValidationIssue

Ƭ DateValidationIssue: TypeIssue | MinimumIssue | MaximumIssue | ExclusiveMinimumIssue | ExclusiveMaximumIssue

Defined in

date-validator.ts:39

---

DateValidator

Ƭ DateValidator: Validator<Date, DateValidationOptions, DateValidationIssue>

Defined in

date-validator.ts:53

---

NumberValidationIssue

Ƭ NumberValidationIssue: TypeIssue | MinimumIssue | MaximumIssue | ExclusiveMinimumIssue | ExclusiveMaximumIssue

Defined in

number-validator.ts:39

---

NumberValidator

Ƭ NumberValidator: Validator<number, NumberValidationOptions, NumberValidationIssue>

Defined in

number-validator.ts:53

---

StandardValidator

Ƭ StandardValidator: ArrayValidator | BooleanValidator | DateValidator | NumberValidator | ObjectValidator | StringValidator

Defined in

standard-validators.ts:19

---

StringValidationIssue

Ƭ StringValidationIssue: TypeIssue | MinLengthIssue | MaxLengthIssue

Defined in

string-validator.ts:25

---

StringValidator

Ƭ StringValidator: Validator<string, StringValidationOptions, StringValidationIssue>

Defined in

string-validator.ts:32

---

Validator

Ƭ Validator<Input, Options, Issue>: (input: Input, options?: Options) => undefined | Issue[]

Type parameters

Name	Type
Input	unknown
Options	ValidationOptions
Issue	ValidationIssue<Input>

Type declaration

▸ (input, options?): undefined | Issue[]

Parameters

Name	Type
input	Input
options?	Options

Returns

undefined | Issue[]

Defined in

validator.ts:38

---

ValidatorForFn

Ƭ ValidatorForFn<V>: (type: string) => V | undefined

Type parameters

Name	Type
V	Validator

Type declaration

▸ (type): V | undefined

Parameters

Name	Type
type	string

Returns

V | undefined

Defined in

validator-builder.ts:4

Variables

standardValidators

• standardValidators: Dict<StandardValidator>

Defined in

standard-validators.ts:27

Functions

buildValidatorFor

▸ buildValidatorFor<V>(settings): ValidatorForFn<V>

Type parameters

Name	Type
V	Validator<unknown, ValidationOptions, ValidationIssue<unknown, unknown>>

Parameters

Name	Type
settings	Object
settings.validators	Dict<V>

Returns

ValidatorForFn<V>

Defined in

validator-builder.ts:6

---

formatValidationDescription

▸ formatValidationDescription(summary, issues?): string

Parameters

Name	Type
summary	string
issues?	ValidationIssue<unknown, unknown>[]

Returns

string

Defined in

validator.ts:44

---

validateArray

▸ Const validateArray(input, options?): undefined | ArrayValidationIssue[]

Parameters

Name	Type
input	unknown[]
options?	ArrayValidationOptions

Returns

undefined | ArrayValidationIssue[]

Defined in

array-validator.ts:38

---

validateBoolean

▸ Const validateBoolean(input, options?): undefined | TypeIssue[]

Parameters

Name	Type
input	boolean
options?	undefined

Returns

undefined | TypeIssue[]

Defined in

boolean-validator.ts:19

---

validateDate

▸ Const validateDate(input, options?): undefined | DateValidationIssue[]

Parameters

Name	Type
input	Date
options?	DateValidationOptions

Returns

undefined | DateValidationIssue[]

Defined in

date-validator.ts:59

---

validateNumber

▸ Const validateNumber(input, options?): undefined | NumberValidationIssue[]

Parameters

Name	Type
input	number
options?	NumberValidationOptions

Returns

undefined | NumberValidationIssue[]

Defined in

number-validator.ts:59

---

validateString

▸ Const validateString(input, options?): undefined | StringValidationIssue[]

Parameters

Name	Type
input	string
options?	StringValidationOptions

Returns

undefined | StringValidationIssue[]

Defined in

string-validator.ts:38