headers

headers は 非同期 関数で、サーバーコンポーネント から HTTP 受信リクエストヘッダーを 読み取る ことができます。

import { headers } from 'next/headers'

export default async function Page() {
  const headersList = await headers()
  const userAgent = headersList.get('user-agent')
}

リファレンス

パラメータ

headers はパラメータを取りません。

戻り値

headers は 読み取り専用 の Web Headers オブジェクトを返します。

• Headers.entries(): このオブジェクトに含まれるすべてのキー/値ペアを走査できる イテレータ を返します。
• Headers.forEach(): この Headers オブジェクト内の各キー/値ペアに対して指定された関数を1回実行します。
• Headers.get(): 指定された名前のヘッダーのすべての値を String シーケンスとして返します。
• Headers.has(): Headers オブジェクトに特定のヘッダーが含まれているかどうかを示すブール値を返します。
• Headers.keys(): このオブジェクトに含まれるキー/値ペアのすべてのキーを走査できる イテレータ を返します。
• Headers.values(): このオブジェクトに含まれるキー/値ペアのすべての値を走査できる イテレータ を返します。

知っておくと良いこと

• headers は 非同期 関数で、Promise を返します。async/await または React の use 関数を使用する必要があります。
  • バージョン14以前では、headers は同期関数でした。後方互換性のために、Next.js 15でも同期的にアクセスできますが、この動作は将来非推奨になります。
• headers は読み取り専用であるため、送信リクエストヘッダーを set または delete することはできません。
• headers は Dynamic API であり、返される値を事前に知ることはできません。これを使用するとルートが 動的レンダリング に切り替わります。

使用例

Authorization ヘッダーの使用

import { headers } from 'next/headers'

export default async function Page() {
  const authorization = (await headers()).get('authorization')
  const res = await fetch('...', {
    headers: { authorization }, // Authorization ヘッダーを転送
  })
  const user = await res.json()

  return <h1>{user.name}</h1>
}

バージョン履歴