throw redirect()

See also:

• config.redirects
• throw render()
• throw redirect() VS throw render()

// Redirect the user to another URL
redirect(url: `/${string}` | `https://${string}` | `http://${string}`)

import { redirect } from 'vite-plugin-ssr/abort'

function onSomeHook() {
  if (someCondition) {
    throw redirect('/some-url')
  }
}

throw redirect() makes temporary redirections (HTTP status code 302). For permanent redirections (HTTP status code 301), you can set config.redirects or pass a second argument throw redirect('/some-url', 301).

While it's most commonly used with guard() or onBeforeRender() you can use it with any hook.

Common use cases:

• Authentication and authorization, see Guides > Authentication > Login flow.
• Data fetching error handling, see Guides > Data Fetching > Error Handling.

If throw redirect() doesn't work, see Abort > Debug.