throw render()

See also:

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

// Render the error page
render(abortStatusCode: 401 | 403 | 404 | 429 | 500 | 503, abortReason?: unknown)
// Render another page (aka URL rewrite)
render(url: `/${string}`, abortReason?: unknown)

If you use TypeScript, you can define the abortReason type by using the global interface Vike.PageContext, see API > _error.page.js.

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

function onSomeHook() {
  if (someCondition) {
    throw render('/login')
  }
  if (someOtherCondition) {
    throw render(401, "You don't have the permission to access this page.")
  }
}

• If the first argument is a URL, then that URL is rendered.
• If the first argument is a status code, then the error page is rendered.
  • 401 Unauthorized - Access denied, the user isn't logged in.
  • 403 Forbidden - Access denied, the user is logged in but isn't allowed.
  • 404 Not Found - Page doesn't exist.
  • 429 Too Many Requests - Purposefully not serving the request, because of rate limiting or to protect from DDoS attacks.
  • 500 Internal Server Error - App has a bug.
  • 503 Service Unavailable - Server is overloaded and/or a third-party API isn't responding.
• The abortReason and abortStatusCode arguments are made available at pageContext.abortReason and pageContext.abortStatusCode which is useful for enabling the error page to show a useful error message to the user, see API > _error.page.js.

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 render() doesn't work, see Abort > Debug.