headers

headers は、Server Component から HTTP の受信リクエストヘッダーを**読み取る**ことができる async 関数です。

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

リファレンス

Parameters

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

戻り値

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

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

Good to know

• 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 }, // Forward the authorization header
  })
  const user = await res.json()
 
  return <h1>{user.name}</h1>
}

バージョン履歴