Validator

Public class

class Validator<T> implements Validatable<T> {}

Validatable

packages/validate/src/lib/validation.ts

Constructor

Public constructor

Constructs a new instance of the Validator class

ValidatorFn<T>

  | undefined
  | ValidatorUsingKnownGoodVersionFn<T, T>

ValidatorFn, ValidatorUsingKnownGoodVersionFn

Properties

validateUsingKnownGoodVersionFn

Public readonly property

readonly validateUsingKnownGoodVersionFn?:
  | undefined
  | ValidatorUsingKnownGoodVersionFn<T, T>

ValidatorUsingKnownGoodVersionFn

validationFn

Public readonly property

readonly validationFn: ValidatorFn<T>

ValidatorFn

Methods

check()

Public method

Refine this validation with an additional check that doesn't change the resulting value.

const numberLessThan10Validator = T.number.check((value) => {
  if (value >= 10) {
    throw new ValidationError(`Expected number less than 10, got ${value}`)
  }
})

check(name: string, checkFn: (value: T) => void): Validator<T>

string

(value: T) => void

Validator<T>

Validator

check()

Public method

check(checkFn: (value: T) => void): Validator<T>

(value: T) => void

Validator<T>

Validator

isValid()

Public method

Checks that the passed value is of the correct type.

isValid(value: unknown): value is T

unknown

value is T

nullable()

Public method

Returns a new validator that also accepts null or undefined. The resulting value will always be null.

nullable(): Validator<null | T>

Validator

optional()

Public method

Returns a new validator that also accepts null or undefined. The resulting value will always be null.

optional(): Validator<T | undefined>

Validator

refine()

Public method

Refine this validation to a new type. The passed-in validation function should throw an error if the value can't be converted to the new type, or return the new type otherwise.

refine<U>(otherValidationFn: (value: T) => U): Validator<U>

(value: T) => U

Validator<U>

Validator

validate()

Public method

Asserts that the passed value is of the correct type and returns it. The returned value is guaranteed to be referentially equal to the passed value.

validate(value: unknown): T

unknown

T

validateUsingKnownGoodVersion()

Public method

validateUsingKnownGoodVersion(knownGoodValue: T, newValue: unknown): T

T

unknown

T