Interface AstroSharedContext<Props, RouteParams>

interface AstroSharedContext<Props, RouteParams> {
    clientAddress: string;
    cookies: AstroCookies;
    currentLocale: undefined | string;
    getActionResult: (<TAccept, TInputSchema, TAction>(action) => undefined | Awaited<ReturnType<TAction["safe"]>>);
    locals: Locals;
    params: RouteParams;
    preferredLocale: undefined | string;
    preferredLocaleList: undefined | string[];
    props: Props;
    request: Request;
    url: URL;
    redirect(path, status?): Response;
    rewrite(rewritePayload): Promise<Response>;
}

Type Parameters

  • Props extends Record<string, any> = Record<string, any>
  • RouteParams extends Record<string, string | undefined> = Record<string, string | undefined>

Hierarchy (view full)

Properties

clientAddress cookies currentLocale getActionResult locals params preferredLocale preferredLocaleList props request url

Methods

redirect rewrite

Properties

clientAddress

clientAddress: string

The address (usually IP address) of the user.

Throws an error if used within a static site, or within a prerendered page.

cookies

cookies: AstroCookies

Utility for getting and setting the values of cookies.

currentLocale

currentLocale: undefined | string

The current locale computed from the URL of the request. It matches the locales in i18n.locales, and returns undefined otherwise.

getActionResult

getActionResult: (<TAccept, TInputSchema, TAction>(action) => undefined | Awaited<ReturnType<TAction["safe"]>>)

Get action result on the server when using a form POST.

Type declaration

locals

locals: Locals

Object accessed via Astro middleware

params

params: RouteParams

Route parameters for this request if this is a dynamic route.

preferredLocale

preferredLocale: undefined | string

The current locale that is computed from the Accept-Language header of the browser (SSR Only).

preferredLocaleList

preferredLocaleList: undefined | string[]

The list of locales computed from the Accept-Language header of the browser, sorted by quality value (SSR Only).

props

props: Props

List of props returned for this path by getStaticPaths (Static Only).

request

request: Request

Information about the current request. This is a standard Request object

url

url: URL

A full URL object of the request URL.

Methods

redirect

  • redirect(path, status?): Response

  • Redirect to another page (SSR Only).

    Parameters

    Returns Response

rewrite

  • rewrite(rewritePayload): Promise<Response>

  • It rewrites to another page. As opposed to redirects, the URL won't change, and Astro will render the HTML emitted by the rerouted URL passed as argument.

    Example

    if (pageIsNotEnabled) {
        return Astro.rewrite('/fallback-page')
    }

    Parameters

    Returns Promise<Response>

Settings

Member Visibility

Theme

On This Page

clientAddresscookiescurrentLocalegetActionResultlocalsparamspreferredLocalepreferredLocaleListpropsrequesturlredirectrewrite