Function requireThatString

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

  • Validates the state of a string.

    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 | string

      the type the value

    Parameters

    • value: T

      the value

    • name: string

      the name of the value

    Returns StringValidator<T>

    validator for the value

    Throws

    TypeError if name is undefined or null

    Throws

    RangeError if name is empty

Settings

Member Visibility