NextRequest

NextRequestは、Web Request APIに追加の便利なメソッドを提供します。

`cookies`

リクエストのSet-Cookieヘッダーを読み取るか変更します。

`set(name, value)`

名前を指定して、リクエストに指定された値を持つクッキーを設定します。

// 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)`

クッキー名を与えると、そのクッキーの値を返します。クッキーが見つからない場合は、`undefined` を返します。複数のクッキーが見つかった場合は、最初のクッキーが返されます。

// 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)`

クッキー名を与えると、リクエストにそのクッキーが存在する場合は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`	`文字列`	URLのベースパス。
`buildId`	`文字列` \| `未定義`	Next.jsアプリケーションのビルド識別子。カスタマイズできます。
`defaultLocale`	`文字列` \| `未定義`	国際化のデフォルトロケール。
`domainLocale`
- `defaultLocale`	`文字列`	ドメイン内のデフォルトロケール。
- `domain`	`文字列`	特定のロケールに関連付けられたドメイン。
- `http`	`真偽値` \| `未定義`	ドメインがHTTPを使用しているかどうかを示します。
`locales`	`文字列配列` \| `未定義`	利用可能なロケールの配列。
`locale`	`文字列` \| `未定義`	現在アクティブなロケール。
`url`	`URL`	URLオブジェクト。

バージョン履歴

バージョン	変更点
`v15.0.0`	`ip`と`geo`を削除しました。