跳转到内容
API 参考函数NextRequest

NextRequest

NextRequest 扩展了 Web 请求 API，并添加了一些便捷方法。

cookies

读取或更改请求的 Set-Cookie 标头。

set(name, value)

给定名称，使用给定的值在请求上设置 Cookie。

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

get(name)

给定 Cookie 名称，返回 Cookie 的值。如果未找到 Cookie，则返回 undefined。如果找到多个 Cookie，则返回第一个。

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

getAll()

给定 Cookie 名称，返回 Cookie 的值。如果未提供名称，则返回请求中的所有 Cookie。

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

delete(name) 
// Returns true for deleted, false is nothing is deleted
request.cookies.delete('experiments')

has(name) 
// Returns true if cookie exists, false if it does not
request.cookies.has('experiments')

clear() 
request.cookies.clear()

nextUrl URL API，包括 Next.js 特定的属性。

// Given a request to /home, pathname is /home
request.nextUrl.pathname
// Given a request to /home?name=lee, searchParams is { 'name': 'lee' }
request.nextUrl.searchParams

以下选项可用

属性类型描述
basePath字符串URL 的 基本路径。
buildIdstring | undefinedNext.js 应用程序的构建标识符。可以 自定义。
pathname字符串URL 的路径名。
searchParams对象URL 的搜索参数。

注意：页面路由器的国际化属性不能在应用程序路由器中使用。详细了解应用程序路由器的国际化。

版本历史
版本变更
v15.0.0移除了 ip 和 geo。