@cowwoc/requirements/node/validator/MapValidator.d.mts

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

import { type ValidatorComponent, type ArrayValidator, type UnsignedNumberValidator } from "../internal/internal.mjs";
/**
 * Validates the state of a `Map`.
 *
 * @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
 */
interface MapValidator<T extends Map<K, V> | undefined | null, K, V> extends ValidatorComponent<T> {
    /**
     * Returns a validator for the map's {@link Map.keys|keys}.
     * @returns a validator for the map's {@link Map.keys|keys}
     * @throws TypeError if the value is `undefined` or `null`
     */
    keys(): ArrayValidator<K[], K>;
    /**
     * Returns a validator for the map's {@link Map.values|values}.
     *
     * @returns a validator for the map's {@link Map.values|values}
     * @throws TypeError if the value is `undefined` or `null`
     */
    values(): ArrayValidator<V[], V>;
    /**
     * Returns a validator for the map's {@link Map.entries|entries}
     * (an array of `[key, this.value]` for each element in the Map).
     *
     * @returns a validator for the map's {@link Map.entries|entries}
     * @throws TypeError if the value is `undefined` or `null`
     */
    entries(): ArrayValidator<[K, V][], [K, V]>;
    /**
     * Ensures that the value is empty.
     *
     * @returns this
     * @throws TypeError     if the value is `undefined` or `null`
     * @throws RangeError if value is not empty
     */
    isEmpty(): this;
    /**
     * Ensures that the value is not empty.
     *
     * @returns this
     * @throws TypeError     if the value is `undefined` or `null`
     * @throws RangeError if value is empty
     */
    isNotEmpty(): this;
    /**
     * Returns a validator for the map's {@link Map.size|size}.
     *
     * @returns a validator for the map's {@link Map.size|size}
     * @throws TypeError if the value is `undefined` or `null`
     */
    size(): UnsignedNumberValidator;
}
export type { MapValidator };