This class extends the Web Request API with additional convenience methods.

Read more: Next.js Docs: NextRequest

Hierarchy

  • Request
    • NextRequest

Constructors

  • Parameters

    • input: URL | RequestInfo
    • Optionalinit: RequestInit

    Returns NextRequest

Properties

"[INTERNALS]": { cookies: RequestCookies; nextUrl: NextURL; url: string }
body: null | ReadableStream<Uint8Array>
bodyUsed: boolean
cache: RequestCache

Returns the cache mode associated with request, which is a string indicating how the request will interact with the browser's cache when fetching.

credentials: RequestCredentials

Returns the credentials mode associated with request, which is a string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL.

destination: RequestDestination

Returns the kind of resource requested by request, e.g., "document" or "script".

headers: Headers

Returns a Headers object consisting of the headers associated with request. Note that headers added in the network layer by the user agent will not be accounted for in this object, e.g., the "Host" header.

integrity: string

Returns request's subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. [SRI]

keepalive: boolean

Returns a boolean indicating whether or not request can outlive the global in which it was created.

method: string

Returns request's HTTP method, which is "GET" by default.

mode: RequestMode

Returns the mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs.

redirect: RequestRedirect

Returns the redirect mode associated with request, which is a string indicating how redirects for the request will be handled during fetching. A request will follow redirects by default.

referrer: string

Returns the referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to indicate no referrer, and "about:client" when defaulting to the global's default. This is used during fetching to determine the value of the Referer header of the request being made.

referrerPolicy: ReferrerPolicy

Returns the referrer policy associated with request. This is used during fetching to compute the value of the request's referrer.

signal: AbortSignal

Returns the signal associated with request, which is an AbortSignal object indicating whether or not request has been aborted, and its abort event handler.

Accessors

  • get cookies(): RequestCookies
  • Returns RequestCookies

  • get nextUrl(): NextURL
  • Returns NextURL

  • get page(): void
  • Returns void

    page has been deprecated in favour of URLPattern. Read more: https://nextjs.org/docs/messages/middleware-request-page

  • get ua(): void
  • Returns void

    ua has been removed in favour of userAgent function. Read more: https://nextjs.org/docs/messages/middleware-parse-user-agent

  • get url(): string
  • Returns the URL of request as a string.

    Returns string

Methods

  • Returns Promise<ArrayBuffer>

  • Returns Promise<Blob>

  • Returns Request

  • Returns Promise<FormData>

  • Returns Promise<any>

  • Returns Promise<string>