Interface BooleanValidator<T>

Validates the state of a boolean.

interface BooleanValidator<T extends boolean | undefined | null> {
    and(validation: (validator: this) => void): this;
    elseGetFailures(): ValidationFailures;
    elseThrow(): boolean;
    getContext(): Map<string, unknown>;
    getContextAsString(): string;
    getName(): string;
    getValue(): T;
    getValueOrDefault(defaultValue: T): T;
    getValueOrDefault(defaultValue: null | T): null | T;
    isEqualTo(expected: unknown): this;
    isEqualTo(expected: unknown, name: string): this;
    isFalse(): this;
    isInstanceOf<U extends object>(
        expected: ClassConstructor<U>,
    ): UnknownValidator<U>;
    isNotEqualTo(unwanted: unknown): this;
    isNotEqualTo(unwanted: unknown, name: string): this;
    isNotInstanceOf<U extends object>(unwanted: ClassConstructor<U>): this;
    isNotNull(): UnknownValidator<NonNullable<T>>;
    isNotUndefined(): UnknownValidator<Exclude<T, undefined>>;
    isNull(): UnknownValidator<null>;
    isTrue(): this;
    isType(expected: Type): this;
    isUndefined(): UnknownValidator<undefined>;
    validationFailed(): boolean;
    withContext(value: unknown, name: string): this;
}

Type Parameters

  • T extends boolean | undefined | null

    the type of the value

Hierarchy (View Summary)

Methods

and elseGetFailures elseThrow getContext getContextAsString getName getValue getValueOrDefault isEqualTo isFalse isInstanceOf isNotEqualTo isNotInstanceOf isNotNull isNotUndefined isNull isTrue isType isUndefined validationFailed withContext

Methods

and

  • and(validation: (validator: this) => void): this

  • Facilitates the validation of related properties. For example,

    ```ts requireThat(nameToFrequency, "nameToFrequency"). and(m => m.size().isPositive()). and(m => m.keySet().contains("John")); ```

    Any changes made during the validation process will impact this validator.

    Parameters

    • validation: (validator: this) => void

      the nested validation

    Returns this

    this

    Throws

    TypeError if validation is undefined or null

elseGetFailures

elseThrow

  • elseThrow(): boolean

  • Throws an error if a validation failed; otherwise, returns true.

    Returns boolean

    true if the validation passed

    Throws

    RangeError if a method precondition, class invariant, or method postcondition was violated

    Throws

    MultipleFailuresError if more than one validation failed. This error contains an array of the failures.

getContext

  • getContext(): Map<string, unknown>

  • Returns the contextual information for upcoming validations carried out by this validator. The contextual information is a map of key-value pairs that can provide more details about validation failures. For example, if the message is "Password may not be empty" and the map contains the key-value pair {"username": "john.smith"}, the error message would be:

    Password may not be empty
    username: john.smith

    Returns Map<string, unknown>

    an unmodifiable map from each entry's name to its value

    See

    Validators.getContext

getContextAsString

getName

getValue

getValueOrDefault

isEqualTo

isFalse

  • isFalse(): this

  • Ensures that the value is false.

    Returns this

    this

    Throws

    TypeError if the value is undefined or null

    Throws

    RangeError if the value is true

isInstanceOf

isNotEqualTo

isNotInstanceOf

isNotNull

isNotUndefined

isNull

isTrue

  • isTrue(): this

  • Ensures that the value is true.

    Returns this

    this

    Throws

    TypeError if the value is undefined or null

    Throws

    RangeError if the value is false

isType

isUndefined

validationFailed

withContext

  • withContext(value: unknown, name: string): this

  • Sets the contextual information for upcoming validations.

    This method adds contextual information to error messages. The contextual information is stored as key-value pairs in a map. Values set by this method override any values that are set using Validators.withContext.

    There is no way to remove contextual information from a validator. Thread-level contextual information is removed automatically.

    Parameters

    • value: unknown

      the value of the entry

    • name: string

      the name of an entry

    Returns this

    this

    Throws

    TypeError if name is undefined or null

    Throws

    RangeError if name:

    • contains whitespace
    • is empty
    • is already in use by the value being validated or the validator context

Settings

Member Visibility

On This Page

Methods