APIContext Type — astro Architecture

Source Code

packages/astro/src/types/public/context.ts lines 137–580

export interface APIContext<
	Props extends Record<string, any> = Record<string, any>,
	Params extends Record<string, string | undefined> = Record<string, string | undefined>,
> {
	/**
	 * The site provided in the astro config, parsed as an instance of `URL`, without base.
	 * `undefined` if the site is not provided in the config.
	 *
	 * ## Example
	 *
	 * ```astro
	 * <link
	 *   rel="alternate"
	 *   type="application/rss+xml"
	 *   title="Your Site's Title"
	 *   href={new URL("rss.xml", Astro.site)}
	 * />
	 * ```
	 *
	 * [Astro reference](https://docs.astro.build/en/reference/api-reference/#site)
	 */
	site: URL | undefined;

	/**
	 * A human-readable string representing the Astro version used to create the project. It follows the format "Astro v5.x.x".
	 *
	 * ## Example
	 *
	 * ```astro
	 * <meta name="generator" content={Astro.generator} />
	 * ```
	 *
	 * [Astro reference](https://docs.astro.build/en/reference/api-reference/#generator)
	 */
	generator: string;

	/**
	 * The address (usually IP address) of the user.
	 *
	 * Throws an error if used within a static site, or within a prerendered page.
	 *
	 * ## Example
	 *
	 * ```ts
	 * import type { APIContext } from 'astro';
	 *
	 * export function GET({ clientAddress }: APIContext) {
	 *   return new Response(`Your IP address is: ${clientAddress}`);
	 * }
	 * ```
	 *
	 * [Astro reference](https://docs.astro.build/en/reference/api-reference/#clientaddress)
	 */
	clientAddress: string;

	/**
	 * An object containing utilities for reading and manipulating the values of cookies in on-demand routes.
	 *
	 * [Astro reference](https://docs.astro.build/en/reference/api-reference/#cookies)
	 */
	cookies: AstroCookies;

	/**
	 * An object containing utilities for handling sessions in on-demand rendered routes.
	 *
	 * [Astro reference](https://docs.astro.build/en/reference/api-reference/#session)
	 */
	session: AstroSession | undefined;

	/**
	 * A standard [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing information about the current request.
	 *
	 * ## Example
	 *
	 * To get a URL object of the current URL, you can use:
	 * ```typescript
	 * const url = new URL(Astro.request.url);
	 * ```
	 *
	 * [Astro reference](https://docs.astro.build/en/reference/api-reference/#request)
	 */