headers

Функция headers позволяет читать HTTP-заголовки входящего запроса в Серверном Компоненте (Server Component).

headers()

Этот API расширяет Web Headers API. Он является только для чтения, то есть вы не можете изменять (set) или удалять (delete) заголовки исходящего запроса.

import { headers } from 'next/headers'

export default function Page() {
  const headersList = headers()
  const referer = headersList.get('referer')

  return <div>Referer: {referer}</div>
}

import { headers } from 'next/headers'

export default function Page() {
  const headersList = headers()
  const referer = headersList.get('referer')

  return <div>Referer: {referer}</div>
}

Полезно знать:

• headers() является Динамической Функцией (Dynamic Function), возвращаемые значения которой невозможно предсказать заранее. Её использование в layout или page переведёт маршрут в режим динамического рендеринга (dynamic rendering) во время запроса.

Справочник API

const headersList = headers()

Параметры

headers не принимает параметров.

Возвращаемое значение

headers возвращает только для чтения объект Web Headers.

• Headers.entries(): Возвращает итератор для перебора всех пар ключ/значение в этом объекте.
• Headers.forEach(): Выполняет переданную функцию один раз для каждой пары ключ/значение в объекте Headers.
• Headers.get(): Возвращает строку со всеми значениями заголовка с указанным именем из объекта Headers.
• Headers.has(): Возвращает булево значение, указывающее, содержит ли объект Headers определённый заголовок.
• Headers.keys(): Возвращает итератор для перебора всех ключей в объекте.
• Headers.values(): Возвращает итератор для перебора всех значений в объекте.

Примеры

Использование с получением данных

headers() можно использовать вместе с Suspense для получения данных (Suspense for Data Fetching).

import { headers } from 'next/headers'

async function getUser() {
  const headersInstance = headers()
  const authorization = headersInstance.get('authorization')
  // Пересылаем заголовок authorization
  const res = await fetch('...', {
    headers: { authorization },
  })
  return res.json()
}

export default async function UserPage() {
  const user = await getUser()
  return <h1>{user.name}</h1>
}

История версий