Interface RequestMeta

interface RequestMeta {
    PagesErrorDebug?: ((__namedParameters) => "/home/runner/work/amplify-js/amplify-js/amplify-js/node_modules/@types/react/jsx-runtime");
    bubbleNoFallback?: true;
    cacheBustingSearchParam?: string;
    clonableBody?: CloneableBody;
    customErrorRender?: true;
    defaultLocale?: string;
    devFallbackParams?: OpaqueFallbackRouteParams;
    devGenerateStaticParamsDuration?: bigint;
    devRequestTimingInternalsEnd?: bigint;
    devRequestTimingMiddlewareEnd?: bigint;
    devRequestTimingMiddlewareStart?: bigint;
    devRequestTimingStart?: bigint;
    developmentNotFoundSourcePage?: string;
    didStripLocale?: boolean;
    distDir?: string;
    incrementalCache?: IncrementalCache;
    initProtocol?: string;
    initQuery?: ParsedUrlQuery;
    initURL?: string;
    invokeError?: Error;
    invokeOutput?: string;
    invokePath?: string;
    invokeQuery?: Record<string, undefined | string | string[]>;
    invokeStatus?: number;
    isLocaleDomain?: boolean;
    isNextDataReq?: true;
    isPrefetchRSCRequest?: true;
    isRSCRequest?: true;
    locale?: string;
    localeInferredFromDefault?: true;
    match?: RouteMatch<RouteDefinition<RouteKind>>;
    middlewareCookie?: string[];
    middlewareInvoke?: boolean;
    minimalMode?: boolean;
    notFoundRevalidate?: number | false;
    onCacheEntry?: OnCacheEntryHandler;
    onCacheEntryV2?: OnCacheEntryHandler;
    params?: ParsedUrlQuery;
    postponed?: string;
    query?: ParsedUrlQuery;
    relativeProjectDir?: string;
    renderFallbackShell?: boolean;
    rewroteURL?: string;
    segmentPrefetchRSCRequest?: string;
    serverComponentsHmrCache?: ServerComponentsHmrCache;
}

Properties

PagesErrorDebug? bubbleNoFallback? cacheBustingSearchParam? clonableBody? customErrorRender? defaultLocale? devFallbackParams? devGenerateStaticParamsDuration? devRequestTimingInternalsEnd? devRequestTimingMiddlewareEnd? devRequestTimingMiddlewareStart? devRequestTimingStart? developmentNotFoundSourcePage? didStripLocale? distDir? incrementalCache? initProtocol? initQuery? initURL? invokeError? invokeOutput? invokePath? invokeQuery? invokeStatus? isLocaleDomain? isNextDataReq? isPrefetchRSCRequest? isRSCRequest? locale? localeInferredFromDefault? match? middlewareCookie? middlewareInvoke? minimalMode? notFoundRevalidate? onCacheEntry? onCacheEntryV2? params? postponed? query? relativeProjectDir? renderFallbackShell? rewroteURL? segmentPrefetchRSCRequest? serverComponentsHmrCache?

Properties

Optional PagesErrorDebug

PagesErrorDebug?: ((__namedParameters) => "/home/runner/work/amplify-js/amplify-js/amplify-js/node_modules/@types/react/jsx-runtime")

ErrorOverlay component to use in development for pages router

Type declaration

Optional bubbleNoFallback

bubbleNoFallback?: true

Whether to bubble up the NoFallbackError to the caller when a 404 is returned.

Optional cacheBustingSearchParam

cacheBustingSearchParam?: string

A search param set by the Next.js client when performing RSC requests. Because some CDNs do not vary their cache entries on our custom headers, this search param represents a hash of the header values. For any cached RSC request, we should verify that the hash matches before responding. Otherwise this can lead to cache poisoning. TODO: Consider not using custom request headers at all, and instead encode everything into the search param.

Optional clonableBody

clonableBody?: CloneableBody

The body that was read from the request. This is used to allow the body to be read multiple times.

Optional customErrorRender

customErrorRender?: true

Whether the request is for the custom error page.

Optional defaultLocale

defaultLocale?: string

The default locale that was inferred or explicitly set for the request.

Optional devFallbackParams

devFallbackParams?: OpaqueFallbackRouteParams

DEV only: The fallback params that should be used when validating prerenders during dev

Optional devGenerateStaticParamsDuration

devGenerateStaticParamsDuration?: bigint

DEV only: The duration of getStaticPaths/generateStaticParams in process.hrtime.bigint()

Optional devRequestTimingInternalsEnd

devRequestTimingInternalsEnd?: bigint

Optional devRequestTimingMiddlewareEnd

devRequestTimingMiddlewareEnd?: bigint

Optional devRequestTimingMiddlewareStart

devRequestTimingMiddlewareStart?: bigint

Optional devRequestTimingStart

devRequestTimingStart?: bigint

DEV only: Request timings in process.hrtime.bigint()

Optional developmentNotFoundSourcePage

developmentNotFoundSourcePage?: string

In development, the original source page that returned a 404.

Optional didStripLocale

didStripLocale?: boolean

True when the request had locale information stripped from the pathname part of the URL.

Optional distDir

distDir?: string

The dist directory the server is currently using

Optional incrementalCache

incrementalCache?: IncrementalCache

The incremental cache to use for the request.

Optional initProtocol

initProtocol?: string

The protocol that was used to make the request.

Optional initQuery

initQuery?: ParsedUrlQuery

The query that was used to make the request.

Optional initURL

initURL?: string

The URL that was used to make the request.

Optional invokeError

invokeError?: Error

The routing error we are invoking with

Optional invokeOutput

invokeOutput?: string

The specific page output we should be matching

Optional invokePath

invokePath?: string

The path we routed to and should be invoked

Optional invokeQuery

invokeQuery?: Record<string, undefined | string | string[]>

The query parsed for the invocation

Optional invokeStatus

invokeStatus?: number

The status we are invoking the request with from routing

Optional isLocaleDomain

isLocaleDomain?: boolean

True when the request matched a locale domain that was configured in the next.config.js file.

Optional isNextDataReq

isNextDataReq?: true

True when the request is for the /_next/data route using the pages router.

Optional isPrefetchRSCRequest

isPrefetchRSCRequest?: true

True when the request is for the prefetch flight data.

Optional isRSCRequest

isRSCRequest?: true

True when the request is for the flight data.

Optional locale

locale?: string

The locale that was inferred or explicitly set for the request.

Optional localeInferredFromDefault

localeInferredFromDefault?: true

True when the request had locale information inferred from the default locale.

Optional match

match?: RouteMatch<RouteDefinition<RouteKind>>

The match on the request for a given route.

Optional middlewareCookie

middlewareCookie?: string[]

The cookies that were added by middleware and were added to the response.

Optional middlewareInvoke

middlewareInvoke?: boolean

Whether the request is a middleware invocation

Optional minimalMode

minimalMode?: boolean

Whether server is in minimal mode (this will be replaced with more specific flags in future)

Optional notFoundRevalidate

notFoundRevalidate?: number | false

The previous revalidate before rendering 404 page for notFound: true

Optional onCacheEntry

onCacheEntry?: OnCacheEntryHandler

If provided, this will be called when a response cache entry was generated or looked up in the cache.

Deprecated

Use onCacheEntryV2 instead.

Optional onCacheEntryV2

onCacheEntryV2?: OnCacheEntryHandler

If provided, this will be called when a response cache entry was generated or looked up in the cache.

Optional params

params?: ParsedUrlQuery

The params after resolving routes

Optional postponed

postponed?: string

Postponed state to use for resumption. If present it's assumed that the request is for a page that has postponed (there are no guarantees that the page actually has postponed though as it would incur an additional cache lookup).

Optional query

query?: ParsedUrlQuery

The query after resolving routes

Optional relativeProjectDir

relativeProjectDir?: string

The relative project dir the server is running in from project root

Optional renderFallbackShell

renderFallbackShell?: boolean

Whether the request should render the fallback shell or not.

Optional rewroteURL

rewroteURL?: string

If the request had it's URL rewritten, this is the URL it was rewritten to.

Optional segmentPrefetchRSCRequest

segmentPrefetchRSCRequest?: string

Equals the segment path that was used for the prefetch RSC request.

Optional serverComponentsHmrCache

serverComponentsHmrCache?: ServerComponentsHmrCache

The server components HMR cache, only for dev.

Settings

Member Visibility

Theme

On This Page