Interface JavascriptRequireThat

Creates validators for the Javascript API that throw errors immediately on validation failure.

interface JavascriptRequireThat {
    requireThat<T>(value: T, name: string): UnknownValidator<T>;
    requireThatArray<T extends undefined | null | E[], E>(
        value: T,
        name: string,
    ): ArrayValidator<T, E>;
    requireThatBoolean<T extends undefined | null | boolean>(
        value: T,
        name: string,
    ): BooleanValidator<T>;
    requireThatMap<T extends undefined | null | Map<K, V>, K, V>(
        value: T,
        name: string,
    ): MapValidator<T, K, V>;
    requireThatNumber<T extends undefined | null | number>(
        value: T,
        name: string,
    ): NumberValidator<T>;
    requireThatSet<T extends undefined | null | Set<E>, E>(
        value: T,
        name: string,
    ): SetValidator<T, E>;
    requireThatString<T extends undefined | null | string>(
        value: T,
        name: string,
    ): StringValidator<T>;
}

Implemented by

Methods

requireThat requireThatArray requireThatBoolean requireThatMap requireThatNumber requireThatSet requireThatString

Methods

requireThat

  • requireThat<T>(value: T, name: string): UnknownValidator<T>

  • Validates the state of an unknown value or a value that does not have a specialized validator.

    The returned validator throws an error immediately if a validation fails.

    Type Parameters

    • T

      the type of the value

    Parameters

    • value: T

      the value

    • name: string

      the name of the value

    Returns UnknownValidator<T>

    a validator for the value

    Throws

    TypeError if name is undefined or null

    Throws

    RangeError if name contains whitespace or is empty

requireThatArray

  • requireThatArray<T extends undefined | null | E[], E>(
        value: T,
        name: string,
    ): ArrayValidator<T, E>

  • Validates the state of an array.

    The returned validator throws an error immediately if a validation fails.

    Type Parameters

    • T extends undefined | null | E[]

      the type of the value

    • E

      the type of elements in the collection

    Parameters

    • value: T

      the value

    • name: string

      the name of the value

    Returns ArrayValidator<T, E>

    a validator for the value

    Throws

    TypeError if name is undefined or null

    Throws

    RangeError if name contains whitespace or is empty

requireThatBoolean

  • requireThatBoolean<T extends undefined | null | boolean>(
        value: T,
        name: string,
    ): BooleanValidator<T>

  • Validates the state of a boolean.

    The returned validator throws an error immediately if a validation fails.

    Type Parameters

    • T extends undefined | null | boolean

      the type of the value

    Parameters

    • value: T

      the value

    • name: string

      the name of the value

    Returns BooleanValidator<T>

    a validator for the value

    Throws

    TypeError if name is undefined or null

    Throws

    RangeError if name contains whitespace or is empty

requireThatMap

  • requireThatMap<T extends undefined | null | Map<K, V>, K, V>(
        value: T,
        name: string,
    ): MapValidator<T, K, V>

  • Validates the state of a Map.

    The returned validator throws an error immediately if a validation fails.

    Type Parameters

    • T extends undefined | null | Map<K, V>

      the type of the value

    • K

      the type of keys in the map

    • V

      the type of values in the map

    Parameters

    • value: T

      the value

    • name: string

      the name of the value

    Returns MapValidator<T, K, V>

    a validator for the value

    Throws

    TypeError if name is undefined or null

    Throws

    RangeError if name contains whitespace or is empty

requireThatNumber

  • requireThatNumber<T extends undefined | null | number>(
        value: T,
        name: string,
    ): NumberValidator<T>

  • Validates the state of a number.

    The returned validator throws an error immediately if a validation fails.

    Type Parameters

    • T extends undefined | null | number

      the type of the value

    Parameters

    • value: T

      the value

    • name: string

      the name of the value

    Returns NumberValidator<T>

    a validator for the value

    Throws

    TypeError if name is undefined or null

    Throws

    RangeError if name contains whitespace or is empty

requireThatSet

  • requireThatSet<T extends undefined | null | Set<E>, E>(
        value: T,
        name: string,
    ): SetValidator<T, E>

  • Validates the state of a Set.

    The returned validator throws an error immediately if a validation fails.

    Type Parameters

    • T extends undefined | null | Set<E>

      the type of the value

    • E

      the type of elements in the set

    Parameters

    • value: T

      the value

    • name: string

      the name of the value

    Returns SetValidator<T, E>

    a validator for the value

    Throws

    TypeError if name is undefined or null

    Throws

    RangeError if name contains whitespace or is empty

requireThatString

  • requireThatString<T extends undefined | null | string>(
        value: T,
        name: string,
    ): StringValidator<T>

  • Validates the state of a string.

    The returned validator throws an error immediately if a validation fails.

    Type Parameters

    • T extends undefined | null | string

      the type of the value

    Parameters

    • value: T

      the value

    • name: string

      the name of the value

    Returns StringValidator<T>

    a validator for the value

    Throws

    TypeError if name is undefined or null

    Throws

    RangeError if name contains whitespace or is empty

Settings

Member Visibility

On This Page

Methods