跳至内容
API 参考函数NextRequest

NextRequest

NextRequest 扩展了 Web Request 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() 
// 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 应用程序的构建标识符。可以 自定义。
defaultLocalestring | undefined国际化 的默认语言环境。
domainLocale
- defaultLocale字符串域内的默认语言环境。
- domain字符串与特定语言环境关联的域。
- httpboolean | undefined指示域是否正在使用 HTTP。
localesstring[] | undefined可用语言环境数组。
localestring | undefined当前活动的语言环境。
urlURLURL 对象。

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