@arcjet/headers/index.d.ts

Arcjet extension of the Headers class

type HeadersInit = Headers | Array<[string, string]> | Record<string, Array<string> | string | undefined>;
/**
 * Arcjet headers.
 *
 * This exists to prevent the `cookie` header from being set
 * and non-string values from being set.
 *
 * @see
 *   [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers).
 */
export declare class ArcjetHeaders extends Headers {
    constructor(init?: HeadersInit | undefined);
    /**
     * Append a header while ignoring `cookie`.
     *
     * @see
     *   [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/append)
     *
     * @param key
     *   Header name.
     * @param value
     *   Header value.
     * @returns
     *   Nothing.
     */
    append: (key: string, value: string) => void;
    /**
     * Set a header while ignoring `cookie`.
     *
     * @see
     *   [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/set)
     *
     * @param key
     *   Header key.
     * @param value
     *   Header value.
     * @returns
     *   Nothing.
     */
    set: (key: string, value: string) => void;
}
/**
 * @deprecated
 *   Use the named export `ArcjetHeaders` instead.
 */
export default ArcjetHeaders;