Class defaultAbstract

The default export of the jointz library that exposes static methods for constructing validators.

Hierarchy

  • default

Constructors

constructor

Methods

any array boolean constant json number object or string tuple

Constructors

constructor

Methods

Static any

  • Return a validator that always succeeds but does not limit the type.

    Returns default

Static array

  • Return a validator that checks the value is an array, optionally validating each item in the array

    Type Parameters

    • TItem

    Parameters

    • Optional itemValidator: Validator<TItem>

      validator for the individual array items

    Returns default<TItem>

Static boolean

  • Return a validator that checks that the value is either true or false. This is an alias for constructing a constant validator.

    Returns Validator<boolean>

Static constant

  • Return a constant validator that checks that the value is one of a set of given values.

    Type Parameters

    • T extends AllowedValueTypes[]

    Parameters

    • Rest ...allowedValues: T

      the values that are considered valid. can be numbers, strings, booleans, null, or undefined

    Returns default<T>

Static json

  • Return a validator that checks the string contains JSON that when parsed matches some validation

    Type Parameters

    • T

    Parameters

    • parsed: Validator<T>

      the validation to be applied to the parsed JSON

    Returns Validator<string>

Static number

  • Create a validator that checks that the value is a number. Call additional methods to add constraints to the number.

    Returns default

Static object

  • Create a validator that checks that the value is an object with a given shape.

    By default the object is not allowed to have keys other than what are specified. Call allowUnknownKeys(true) on the returned object validator to allow the object to have keys that are not specified which are not validated.

    Type Parameters

    • TKeys extends Keys

    Parameters

    • keys: TKeys

      validation to apply to each key in the object

    Returns default<TKeys, never, false>

Static or

  • Combine a list of validators to produce a new validator that passes if any of the given validators pass

    Type Parameters

    Parameters

    • Rest ...validators: T | [T]

      validators to combine into an OR expression validator

    Returns default<Infer<T>[number]>

Static string

  • Create a validator that checks the value is a string.

    Returns default

Static tuple

  • Create a validator that checks that the given value is a tuple of values that match the given validators.

    Type Parameters

    Parameters

    • Rest ...validators: T | [T]

      list of validators that the items in the tuple should match in order

    Returns default<Infer<T>>

Settings

Member Visibility

Theme

Generated using TypeDoc