UnionValidator

Extends Validator<TypeOf<Config[keyof Config]> | UnknownValue>.

class UnionValidator<
  Key extends string,
  Config extends UnionValidatorConfig<Key, Config>,
  UnknownValue = never,
> extends Validator<TypeOf<Config[keyof Config]> | UnknownValue> {}

Constructs a new instance of the UnionValidator class

Parameters

Key

Config

(
  value: object,
  variant: string
) => UnknownValue

boolean

Properties

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

readonly validationFn: ValidatorFn<T>

Methods

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

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

Example

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

Parameters

string

(value: T) => void

Returns

Validator<T>

Checks that the passed value is of the correct type.

isValid(value: unknown): value is T

Parameters

unknown

Returns

value is T

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

nullable(): Validator<null | T>

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

optional(): Validator<T | undefined>

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>

Parameters

(value: T) => U

Returns

Validator<U>

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

Parameters

unknown

Returns

T

validateUnknownVariants<Unknown>(
  unknownValueValidation: (value: object, variant: string) => Unknown
): UnionValidator<Key, Config, Unknown>

Parameters

(value: object, variant: string) => Unknown

Returns

UnionValidator<Key, Config, Unknown>

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

Parameters

T

unknown

Returns

T