throw render()

throw render() is like throw redirect() but preserves the URL, see Abort > throw redirect() VS throw render() VS navigate().

// 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)
// /pages/some-page/+someHook.js
import { render } from 'vike/abort'
export function someHook() {
  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.
  • 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.

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

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

Common use cases:

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

See also