跳至內容
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)
// 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)

給定 Cookie 名稱,從請求中刪除 Cookie。

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

has(name)

給定 Cookie 名稱,如果請求上存在該 Cookie,則傳回 true

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

clear()

從請求中移除 Set-Cookie 標頭。

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)string(字串)網址的基底路徑
buildIdstring | undefinedNext.js 應用程式的建置識別碼。可以自訂
defaultLocalestring | undefined國際化的預設語系。
domainLocale
- defaultLocalestring(字串)網域內的預設語系。
- domainstring(字串)與特定語系關聯的網域。
- httpboolean | undefined指示網域是否使用 HTTP。
localesstring[] | undefined可用語系的陣列。
localestring | undefined目前作用中的語系。
urlURLURL 物件。

版本歷史記錄
版本變更
v15.0.0移除 ipgeo