CHeaders

The CHeaders class extends the native Web API Headers with additional utilities for common header names, case-insensitive lookups, batch operations, and header combination. Provides IntelliSense for standard HTTP headers via the CommonHeaders enum.

Usage

import { C } from "@ozanarslan/corpus";

const headers = new C.Headers();

// Set with IntelliSense for common headers
headers.set(C.CommonHeaders.ContentType, "application/json");
headers.set(C.CommonHeaders.Authorization, "Bearer token");

// Case-insensitive get
headers.get("content-type"); // "application/json"
headers.get("Content-Type"); // "application/json"

// Append multiple values
headers.append(C.CommonHeaders.SetCookie, "session=abc");
headers.append(C.CommonHeaders.SetCookie, "user=john");

const headers = new C.Headers();

// From object
headers.setMany({
	[C.CommonHeaders.ContentType]: "application/json",
	[C.CommonHeaders.CacheControl]: "no-cache",
	"X-Custom": "value",
});

// From entries array
headers.setMany([
	["Content-Type", "text/html"],
	["Cache-Control", "max-age=3600"],
]);

const source = new C.Headers();
source.set("X-From", "source");

const target = new C.Headers();
target.set("X-From", "target");

// source into target (modifies target)
source.innerCombine(target);

// Or static method (returns new)
const combined = C.Headers.combine(source, target);
// Set-Cookie headers are appended, others are overwritten

Constructor Parameters

Methods

CommonHeaders Enum

Just some common headers.

type CommonHeaders = ValueOf<typeof CommonHeaders>;

const CommonHeaders = {
	/** Controls caching mechanisms for requests and responses */
	CacheControl: "Cache-Control",
	/** Specifies the media type of the resource or data */
	ContentType: "Content-Type",
	/** Indicates the size of the entity-body in bytes */
	ContentLength: "Content-Length",
	/** Whether to display payload inline within the page or prompt the user to download it as an attachment. */
	ContentDisposition: "Content-Disposition",
	/** Specifies the character encodings that are acceptable */
	AcceptEncoding: "Accept-Encoding",
	/** Informs the server about the types of data that can be sent back */
	Accept: "Accept",
	/** Contains the credentials to authenticate with the server */
	Authorization: "Authorization",
	/** The user agent string of the client software */
	UserAgent: "User-Agent",
	/** The domain name of the server and port number */
	Host: "Host",
	/** The address of the previous web page from which the current request originated */
	Referer: "Referer",
	/** Indicates whether the connection should be kept alive */
	Connection: "Connection",
	/** Requests that the server switch to a different protocol (e.g. WebSocket) */
	Upgrade: "Upgrade",
	/** Used to specify directives that must be obeyed by caching mechanisms */
	Pragma: "Pragma",
	/** The date and time at which the message was sent */
	Date: "Date",
	/** Makes the request conditional based on the ETag of the resource */
	IfNoneMatch: "If-None-Match",
	/** Makes the request conditional based on the last modification date */
	IfModifiedSince: "If-Modified-Since",
	/** An identifier for a specific version of a resource */
	ETag: "ETag",
	/** The date and time after which the response is considered stale */
	Expires: "Expires",
	/** The last modification date of the resource */
	LastModified: "Last-Modified",
	/** Indicates the URL to redirect a page to */
	Location: "Location",
	/** Defines the authentication method that should be used */
	WWWAuthenticate: "WWW-Authenticate",
	/** Determines how long the results of a preflight request can be cached */
	AccessControlMaxAge: "Access-Control-Max-Age",
	/** Indicates whether the response can be shared with resources with credentials */
	AccessControlAllowCredentials: "Access-Control-Allow-Credentials",
	/** Indicates which HTTP method will be used in the actual CORS request */
	AccessControlRequestMethod: "Access-Control-Request-Method",
	/** Indicates which headers can be exposed to the browser in a CORS response */
	AccessControlExposeHeaders: "Access-Control-Expose-Headers",
	/** Indicates which origins are allowed to access the resource */
	AccessControlAllowOrigin: "Access-Control-Allow-Origin",
	/** Specifies the HTTP methods allowed when accessing the resource in a CORS request */
	AccessControlAllowMethods: "Access-Control-Allow-Methods",
	/** Specifies the HTTP headers allowed in a CORS request */
	AccessControlAllowHeaders: "Access-Control-Allow-Headers",
	/** Sends cookies from the server to the client */
	SetCookie: "Set-Cookie",
	/** Sends cookies from the client to the server */
	Cookie: "Cookie",
	/** Determines which headers should be used to select a response from cache when content negotiation is in use */
	Vary: "Vary",
};