@cowwoc/requirements/node/JavascriptCheckIf.d.mts

A fluent API for enforcing design contracts with automatic message generation.

import { type BooleanValidator, type StringValidator, type NumberValidator, type UnknownValidator, type ArrayValidator, type SetValidator, type MapValidator } from "./internal/internal.mjs";
/**
 * Creates validators for the Javascript API that capture errors on validation failure rather than throwing
 * them immediately.
 */
interface JavascriptCheckIf {
    /**
     * Validates the state of a `number`.
     * <p>
     * The returned validator captures errors on validation failure rather than throwing them immediately.
     * These errors can be retrieved or thrown once the validation completes. Errors unrelated to
     * validation failures are thrown immediately.
     *
     * @typeParam T - the type of the value
     * @param value - the value
     * @param name  - the name of the value
     * @returns a validator for the value
     * @throws TypeError if `name` is `undefined` or `null`
     * @throws RangeError if `name` contains whitespace or is empty
     */
    checkIfNumber<T extends number | undefined | null>(value: T, name: string): NumberValidator<T>;
    /**
     * Validates the state of a `boolean`.
     * <p>
     * The returned validator captures errors on validation failure rather than throwing them immediately.
     * These errors can be retrieved or thrown once the validation completes. Errors unrelated to
     * validation failures are thrown immediately.
     *
     * @typeParam T - the type of the value
     * @param value - the value
     * @param name  - the name of the value
     * @returns a validator for the value
     * @throws TypeError if `name` is `undefined` or `null`
     * @throws RangeError if `name` contains whitespace or is empty
     */
    checkIfBoolean<T extends boolean | undefined | null>(value: T, name: string): BooleanValidator<T>;
    /**
     * Validates the state of an array.
     * <p>
     * The returned validator captures errors on validation failure rather than throwing them immediately.
     * These errors can be retrieved or thrown once the validation completes. Errors unrelated to
     * validation failures are thrown immediately.
     *
     * @typeParam T - the type of the value
     * @typeParam E - the type of elements in the collection
     * @param value - the value
     * @param name  - the name of the value
     * @returns a validator for the value
     * @throws TypeError if `name` is `undefined` or `null`
     * @throws RangeError if `name` contains whitespace or is empty
     */
    checkIfArray<T extends E[] | undefined | null, E>(value: T, name: string): ArrayValidator<T, E>;
    /**
     * Validates the state of a `Set`.
     * <p>
     * The returned validator captures errors on validation failure rather than throwing them immediately.
     * These errors can be retrieved or thrown once the validation completes. Errors unrelated to
     * validation failures are thrown immediately.
     *
     * @typeParam T - the type of the value
     * @typeParam E - the type of elements in the set
     * @param value - the value
     * @param name  - the name of the value
     * @returns a validator for the value
     * @throws TypeError if `name` is `undefined` or `null`
     * @throws RangeError if `name` contains whitespace or is empty
     */
    checkIfSet<T extends Set<E> | undefined | null, E>(value: T, name: string): SetValidator<T, E>;
    /**
     * Validates the state of a `Map`.
     * <p>
     * The returned validator captures errors on validation failure rather than throwing them immediately.
     * These errors can be retrieved or thrown once the validation completes. Errors unrelated to
     * validation failures are thrown immediately.
     *
     * @typeParam T - the type of the value
     * @typeParam K - the type of keys in the map
     * @typeParam V - the type of values in the map
     * @param value - the value
     * @param name  - the name of the value
     * @returns a validator for the value
     * @throws TypeError if `name` is `undefined` or `null`
     * @throws RangeError if `name` contains whitespace or is empty
     */
    checkIfMap<T extends Map<K, V> | undefined | null, K, V>(value: T, name: string): MapValidator<T, K, V>;
    /**
     * Validates the state of a `string`.
     * <p>
     * The returned validator captures errors on validation failure rather than throwing them immediately.
     * These errors can be retrieved or thrown once the validation completes. Errors unrelated to
     * validation failures are thrown immediately.
     *
     * @typeParam T - the type of the value
     * @param value - the value
     * @param name  - the name of the value
     * @returns a validator for the value
     * @throws TypeError if `name` is `undefined` or `null`
     * @throws RangeError if `name` contains whitespace or is empty
     */
    checkIfString<T extends string | undefined | null>(value: T, name: string): StringValidator<T>;
    /**
     * Validates the state of an unknown value or a value that does not have a specialized validator.
     * <p>
     * The returned validator captures errors on validation failure rather than throwing them immediately.
     * These errors can be retrieved or thrown once the validation completes. Errors unrelated to
     * validation failures are thrown immediately.
     *
     * @typeParam T - the type of the value
     * @param value - the value
     * @param name  - the name of the value
     * @returns a validator for the value
     * @throws TypeError if `name` is `undefined` or `null`
     * @throws RangeError if `name` contains whitespace or is empty
     */
    checkIf<T>(value: T, name: string): UnknownValidator<T>;
}
export type { JavascriptCheckIf };