@remix-run/headers
Version:
A toolkit for working with HTTP headers in JavaScript
47 lines • 1.56 kB
TypeScript
import { type HeaderValue } from './header-value.ts';
/**
* Initializer for an `If-None-Match` header value.
*/
export interface IfNoneMatchInit {
/**
* The entity tags to compare against the current entity.
*/
tags: string[];
}
/**
* The value of an `If-None-Match` HTTP header.
*
* [MDN `If-None-Match` Reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
*
* [HTTP/1.1 Specification](https://datatracker.ietf.org/doc/html/rfc7232#section-3.2)
*/
export declare class IfNoneMatch implements HeaderValue, IfNoneMatchInit {
tags: string[];
/**
* @param init A string, array of strings, or object to initialize the header
*/
constructor(init?: string | string[] | IfNoneMatchInit);
/**
* 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 this header matches the given entity tag.
*
* @param tag The entity tag to check for
* @return `true` if the tag is present in the header (or the header contains a wildcard), `false` otherwise
*/
matches(tag: string): boolean;
/**
* Returns the string representation of the header value.
*
* @return The header value as a string
*/
toString(): string;
}
//# sourceMappingURL=if-none-match.d.ts.map