Class NextRequest

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

Read more: Next.js Docs: NextRequest

Hierarchy (view full)

Constructors

constructor

Properties

[INTERNALS] arrayBuffer blob body bodyUsed cache clone credentials destination duplex formData headers integrity json keepalive method mode redirect referrer referrerPolicy signal text

Accessors

cookies geo ip nextUrl page ua url

Constructors

constructor

Properties

[INTERNALS]

[INTERNALS]: {
    cookies: RequestCookies;
    geo: undefined | {
        city?: string;
        country?: string;
        latitude?: string;
        longitude?: string;
        region?: string;
    };
    ip?: string;
    nextUrl: NextURL;
    url: string;
}

Type declaration

  • cookies: RequestCookies
  • geo: undefined | {
        city?: string;
        country?: string;
        latitude?: string;
        longitude?: string;
        region?: string;
    }
  • Optional ip?: string
  • nextUrl: NextURL
  • url: string

Readonly arrayBuffer

arrayBuffer: (() => Promise<ArrayBuffer>)

Type declaration

    • (): Promise<ArrayBuffer>

    • Returns Promise<ArrayBuffer>

Readonly blob

blob: (() => Promise<Blob>)

Type declaration

Readonly body

body: null | ReadableStream<any>

Readonly bodyUsed

bodyUsed: boolean

Readonly cache

cache: RequestCache

Readonly clone

clone: (() => Request)

Type declaration

Readonly credentials

credentials: RequestCredentials

Readonly destination

destination: RequestDestination

Readonly duplex

duplex: "half"

Readonly formData

formData: (() => Promise<FormData>)

Type declaration

    • (): Promise<FormData>

    • Returns Promise<FormData>

      Deprecated

      This method is not recommended for parsing multipart/form-data bodies in server environments. It is recommended to use a library such as @fastify/busboy as follows:

      Example

      import { Busboy } from '@fastify/busboy'
      import { Readable } from 'node:stream'

      const response = await fetch('...')
      const busboy = new Busboy({ headers: { 'content-type': response.headers.get('content-type') } })

      // handle events emitted from `busboy`

      Readable.fromWeb(response.body).pipe(busboy)

Deprecated

This method is not recommended for parsing multipart/form-data bodies in server environments. It is recommended to use a library such as @fastify/busboy as follows:

Example

import { Busboy } from '@fastify/busboy'
import { Readable } from 'node:stream'

const response = await fetch('...')
const busboy = new Busboy({ headers: { 'content-type': response.headers.get('content-type') } })

// handle events emitted from `busboy`

Readable.fromWeb(response.body).pipe(busboy)

Readonly headers

headers: Headers

Readonly integrity

integrity: string

Readonly json

json: (() => Promise<unknown>)

Type declaration

    • (): Promise<unknown>

    • Returns Promise<unknown>

Readonly keepalive

keepalive: boolean

Readonly method

method: string

Readonly mode

mode: RequestMode

Readonly redirect

redirect: RequestRedirect

Readonly referrer

referrer: string

Readonly referrerPolicy

referrerPolicy: ReferrerPolicy

Readonly signal

signal: AbortSignal

Readonly text

text: (() => Promise<string>)

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

Accessors

cookies

geo

  • get geo(): undefined | {
        city?: string;
        country?: string;
        latitude?: string;
        longitude?: string;
        region?: string;
    }

  • Returns undefined | {
        city?: string;
        country?: string;
        latitude?: string;
        longitude?: string;
        region?: string;
    }

ip

  • get ip(): undefined | string

  • Returns undefined | string

nextUrl

page

ua

url

  • get url(): string

  • Returns string

Settings

Member Visibility

Theme

On This Page