@remix-run/headers/dist/lib/if-match.d.ts

A toolkit for working with HTTP headers in JavaScript

import { type HeaderValue } from './header-value.ts';
/**
 * Initializer for an `If-Match` header value.
 */
export interface IfMatchInit {
    /**
     * The entity tags to compare against the current entity.
     */
    tags: string[];
}
/**
 * The value of an `If-Match` HTTP header.
 *
 * [MDN `If-Match` Reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match)
 *
 * [HTTP/1.1 Specification](https://datatracker.ietf.org/doc/html/rfc7232#section-3.1)
 */
export declare class IfMatch implements HeaderValue, IfMatchInit {
    tags: string[];
    /**
     * @param init A string, array of strings, or object to initialize the header
     */
    constructor(init?: string | string[] | IfMatchInit);
    /**
     * Checks if the header contains the given entity tag.
     *
     * Note: This method checks only for exact matches and does not consider wildcards.
     *
     * @param tag The entity tag to check for
     * @return `true` if the tag is present in the header, `false` otherwise
     */
    has(tag: string): boolean;
    /**
     * Checks if the precondition passes for the given entity tag.
     *
     * This method always returns `true` if the `If-Match` header is not present
     * since the precondition passes regardless of the entity tag being checked.
     *
     * Uses strong comparison as per RFC 9110, meaning weak entity tags (prefixed with `W/`)
     * will never match.
     *
     * @param tag The entity tag to check against
     * @return `true` if the precondition passes, `false` if it fails (should return 412)
     */
    matches(tag: string): boolean;
    /**
     * Returns the string representation of the header value.
     *
     * @return The header value as a string
     */
    toString(): string;
}
//# sourceMappingURL=if-match.d.ts.map