Class NextResponse<Body>

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

Read more: Next.js Docs: NextResponse

Type Parameters

  • Body = unknown

Hierarchy

  • Response
    • NextResponse

Constructors

constructor

Properties

[INTERNALS] body bodyUsed headers ok redirected status statusText type url

Accessors

cookies

Methods

arrayBuffer blob clone formData json text error json next redirect rewrite

Constructors

constructor

  • new NextResponse<Body = unknown>(
        body?: null | BodyInit,
        init?: ResponseInit,
    ): NextResponse<Body>

  • Type Parameters

    • Body = unknown

    Parameters

    • Optionalbody: null | BodyInit
    • Optionalinit: ResponseInit

    Returns NextResponse<Body>

Properties

[INTERNALS]

"[INTERNALS]": { body?: Body; cookies: ResponseCookies; url?: NextURL }

Readonlybody

body: null | ReadableStream<Uint8Array>

ReadonlybodyUsed

bodyUsed: boolean

Readonlyheaders

headers: Headers

Readonlyok

ok: boolean

Readonlyredirected

redirected: boolean

Readonlystatus

status: number

ReadonlystatusText

statusText: string

Readonlytype

type: ResponseType

Readonlyurl

url: string

Accessors

cookies

  • get cookies(): ResponseCookies

  • Returns ResponseCookies

Methods

arrayBuffer

  • arrayBuffer(): Promise<ArrayBuffer>

  • Returns Promise<ArrayBuffer>

blob

  • blob(): Promise<Blob>

  • Returns Promise<Blob>

clone

  • clone(): Response

  • Returns Response

formData

  • formData(): Promise<FormData>

  • Returns Promise<FormData>

json

  • json(): Promise<any>

  • Returns Promise<any>

text

  • text(): Promise<string>

  • Returns Promise<string>

Staticerror

  • error(): Response

  • Returns Response

Staticjson

  • json<JsonBody>(body: JsonBody, init?: ResponseInit): NextResponse<JsonBody>

  • Type Parameters

    • JsonBody

    Parameters

    • body: JsonBody
    • Optionalinit: ResponseInit

    Returns NextResponse<JsonBody>

Staticnext

  • next(init?: MiddlewareResponseInit): NextResponse<unknown>

  • Parameters

    • Optionalinit: MiddlewareResponseInit

    Returns NextResponse<unknown>

Staticredirect

  • redirect(
        url: string | NextURL | URL,
        init?: number | ResponseInit,
    ): NextResponse<unknown>

  • Parameters

    • url: string | NextURL | URL
    • Optionalinit: number | ResponseInit

    Returns NextResponse<unknown>

Staticrewrite

  • rewrite(
        destination: string | NextURL | URL,
        init?: MiddlewareResponseInit,
    ): NextResponse<unknown>

  • Parameters

    • destination: string | NextURL | URL
    • Optionalinit: MiddlewareResponseInit

    Returns NextResponse<unknown>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods