index.d.ts

/**
 * Request context as dispatched by the platform adapter
 */
export interface AdapterRequestContext<P = unknown> {
	/**
	 * The request. @see https://developer.mozilla.org/en-US/docs/Web/API/Request
	 */
	request: Request;
	/**
	 * IP address that generated the request. Check with the platform adapter
	 * documentation to understand how it is generated.
	 */
	ip: string;
	/**
	 * Platform specific stuff. Check with the platform adapter documentation for
	 * more information.
	 */
	platform: P;
	/**
	 * Get the value of an environment variable. Check with the platform adapter
	 * documentation for the specifics of how environment variables are handled.
	 *
	 * @param variable The name of the variable to get.
	 *
	 * @returns The value of the variable or undefined if it doesn't exist.
	 */
	env(variable: string): string | undefined;
	/**
	 * Signal that the request hasn't been handled and the returned response is
	 * a placeholder (usually a 404). In this case the adapter should handle the
	 * request itself if it has a way to do that. For example, an Express
	 * middleware adapter may call next() to let the next middleware handle the
	 * request. An edge adapter may pass through the request to the origin
	 * server. Other adapters may return the placeholder and ignore this call.
	 */
	passThrough(): void;
	/**
	 * Some platforms (e.g. Cloudflare Workers) require this to be called to
	 * keep running after the response is returned when streaming responses.
	 * This is a no-op if the platform adapter doesn't need to do anything.
	 */
	waitUntil(promise: Promise<any>): void;
}

/**
 * Main handler that adapters expect.
 *
 * @returns A response or a promise that resolves to a response.
 * @see https://developer.mozilla.org/en-US/docs/Web/API/Response
 */
export type HattipHandler<P = unknown> = (
	context: AdapterRequestContext<P>,
) => Response | Promise<Response>;

declare global {
	interface Headers {
		getSetCookie(): string[];
	}
}