Spec-Zone.ru › Next.js

NextResponse

NextResponse расширяет Web Response API дополнительными удобными методами.

cookies

Чтение или изменение заголовка Set-Cookie ответа.

set(name, value)

Установите cookie с заданным значением для ответа, используя имя.

// Given incoming request /home
let response = NextResponse.next()
// Set a cookie to hide the banner
response.cookies.set('show-banner', 'false')
// Response will have a `Set-Cookie:show-banner=false;path=/home` header
return response

get(name)

По заданному имени cookie верните его значение. Если cookie не найдено, возвращается undefined. Если найдено несколько cookie, возвращается первое.

// Given incoming request /home
let response = NextResponse.next()
// { name: 'show-banner', value: 'false', Path: '/home' }
response.cookies.get('show-banner')

getAll()

По заданному имени cookie верните значения cookie. Если имя не указано, верните все cookie в ответе.

// Given incoming request /home
let response = NextResponse.next()
// [
//   { name: 'experiments', value: 'new-pricing-page', Path: '/home' },
//   { name: 'experiments', value: 'winter-launch', Path: '/home' },
// ]
response.cookies.getAll('experiments')
// Alternatively, get all cookies for the response
response.cookies.getAll()

delete(name)

Удалите cookie из ответа по заданному имени.

// Given incoming request /home
let response = NextResponse.next()
// Returns true for deleted, false is nothing is deleted
response.cookies.delete('experiments')

json()

Сгенерировать ответ с заданным телом JSON.

import { NextResponse } from 'next/server'
 
export async function GET(request: Request) {
  return NextResponse.json({ error: 'Internal Server Error' }, { status: 500 })
}

redirect()

Сгенерировать ответ, перенаправляющий на URL.

import { NextResponse } from 'next/server'
 
return NextResponse.redirect(new URL('/new', request.url))

Объект URL можно создать и изменить перед использованием в методе NextResponse.redirect(). Например, вы можете использовать свойство request.nextUrl, чтобы получить текущий URL, а затем изменить его, чтобы перенаправить на другой URL.

import { NextResponse } from 'next/server'
 
// Given an incoming request...
const loginUrl = new URL('/login', request.url)
// Add ?from=/incoming-url to the /login URL
loginUrl.searchParams.set('from', request.nextUrl.pathname)
// And redirect to the new URL
return NextResponse.redirect(loginUrl)

rewrite()

Сгенерировать ответ, который переписывает (проксирует) указанный URL, сохраняя при этом оригинальный URL.

import { NextResponse } from 'next/server'
 
// Incoming request: /about, browser shows /about
// Rewritten request: /proxy, browser shows /about
return NextResponse.rewrite(new URL('/proxy', request.url))

next()

Метод next() полезен для Middleware, поскольку он позволяет вам выполнить возврат рано и продолжить маршрутизацию.

import { NextResponse } from 'next/server'
 
return NextResponse.next()

Вы также можете передать headers при создании ответа:

import { NextResponse } from 'next/server'
 
// Given an incoming request...
const newHeaders = new Headers(request.headers)
// Add a new header
newHeaders.set('x-version', '123')
// And produce a response with the new headers
return NextResponse.next({
  request: {
    // New request headers
    headers: newHeaders,
  },
})

© 2024 Vercel, Inc.
Licensed under the MIT License.
https://nextjs.org/docs/app/api-reference/functions/next-response

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API