Middleware

Middleware allows you to run code before rendering layouts and pages.

Before middleware

A page or layout can export a before function to run middleware before rendering:

// src/pages/posts/index.page.tsx

export async function before() {
  console.log("Running middleware before rendering");
}

export default function IndexPage() {
  return <p>Hello, world!</p>;
}

A layout can also export a before middleware function:

// src/pages/posts/layout.tsx

export async function before() {
  console.log("Running middleware before rendering");
}

export default function PostsLayout() {
  // ...
}

If a page and its layout both export a before middleware function, both of these functions will be run in parallel. Rendering will not start until all middleware functions have completed.

Props

Middleware will receive the same props given to pages and layouts: