permanentRedirect

Функция permanentRedirect позволяет перенаправлять пользователя на другой URL. permanentRedirect может использоваться в серверных компонентах (Server Components), клиентских компонентах (Client Components), обработчиках маршрутов (Route Handlers) и серверных действиях (Server Actions).

При использовании в потоковом контексте (streaming context) функция вставляет мета-тег для выполнения перенаправления на стороне клиента. При использовании в серверном действии (server action) она возвращает HTTP-ответ с кодом 303 (See Other). В остальных случаях возвращается HTTP-ответ с кодом 308 (Permanent Redirect).

Если ресурс не существует, вместо этого можно использовать функцию notFound.

Полезно знать: Если вам нужно вернуть временное перенаправление с кодом 307 (Temporary Redirect) вместо постоянного (308), используйте функцию redirect.

Параметры

Функция permanentRedirect принимает два аргумента:

permanentRedirect(path, type)

По умолчанию permanentRedirect использует push (добавляет новую запись в стек истории браузера) в серверных действиях (Server Actions) и replace (заменяет текущий URL в стеке истории браузера) во всех остальных случаях. Это поведение можно переопределить, указав параметр type.

Параметр type не имеет эффекта при использовании в серверных компонентах (Server Components).

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

Функция permanentRedirect не возвращает никакого значения.

Пример

Вызов функции permanentRedirect() вызывает ошибку NEXT_REDIRECT и прекращает рендеринг сегмента маршрута, в котором она была вызвана.

import { permanentRedirect } from 'next/navigation'

async function fetchTeam(id) {
  const res = await fetch('https://...')
  if (!res.ok) return undefined
  return res.json()
}

export default async function Profile({ params }) {
  const team = await fetchTeam(params.id)
  if (!team) {
    permanentRedirect('/login')
  }

  // ...
}

Полезно знать: Для permanentRedirect не требуется использовать return permanentRedirect(), так как функция использует тип TypeScript never.