Function assertThatMap

  • assertThatMap<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 exception immediately if a validation fails. This exception is then converted into an AssertionError. Exceptions unrelated to validation failures are not converted.

    Type Parameters

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

      the type the value

    • K

      the type of keys in the map

    • V

      the type of values in the map

    Parameters

    • value: T

      the value

    • Optionalname: string

      the name of the value

    Returns MapValidator<T, K, V>

    validator for the value

    Throws

    TypeError if name is undefined or null

    Throws

    RangeError if name is empty

Settings

Member Visibility