permanentRedirect

permanentRedirect 関数を使用すると、ユーザーを別のURLにリダイレクトできます。permanentRedirect はサーバーコンポーネント、クライアントコンポーネント、Route Handlers(ルートハンドラ)Server Actions(サーバーアクション) で使用可能です。

ストリーミングコンテキストで使用すると、クライアントサイドでリダイレクトを実行するためのmetaタグが挿入されます。サーバーアクションで使用すると、呼び出し元に303 HTTPリダイレクトレスポンスが返されます。それ以外の場合、呼び出し元に308(恒久的)HTTPリダイレクトレスポンスが返されます。

リソースが存在しない場合は、代わりにnotFound 関数を使用できます。

補足: 308(恒久的)ではなく307(一時的)HTTPリダイレクトを返したい場合は、代わりにredirect 関数を使用できます。

パラメータ

permanentRedirect 関数は2つの引数を受け取ります:

permanentRedirect(path, type)
パラメータタイプ説明
pathstringリダイレクト先のURL。相対パスまたは絶対パスを指定可能。
type'replace' (デフォルト) または 'push' (Server Actionsではデフォルト)実行するリダイレクトのタイプ。

デフォルトでは、permanentRedirectServer Actions(サーバーアクション)ではpush(ブラウザの履歴スタックに新しいエントリを追加)を、それ以外の場所ではreplace(ブラウザの履歴スタックの現在のURLを置換)を使用します。typeパラメータを指定することでこの動作を上書きできます。

typeパラメータはサーバーコンポーネントで使用した場合には効果がありません。

戻り値

permanentRedirect は値を返しません。

使用例

permanentRedirect()関数を呼び出すと、NEXT_REDIRECTエラーがスローされ、スローされたルートセグメントのレンダリングが終了します。

app/team/[id]/page.js
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 はTypeScriptのnever型を使用しているため、return permanentRedirect() を使用する必要はありません。