[]previous and next page

RouteMiddlewareSource

The middleware manifest source of an app.

The middleware manifest source of an app.

Import#

ts
import type { RouteMiddlewareSource } from "@shadow-js/dusk/vite";

Signature#

ts
interface RouteMiddlewareSource {
  /** Route-level modules, keyed by route id (pages and layouts with a `middleware` export). */
  readonly routes: readonly MiddlewareSourceModule[];
  /** `_middleware` modules, keyed by folder (`""` for the routes root). */
  readonly directories: readonly MiddlewareSourceModule[];
  /** Page route id to the folders whose `_middleware` applies, outermost first. */
  readonly pages: readonly { readonly id: string; readonly folders: readonly string[] }[];
  /** API route id to the folders whose `_middleware` applies, outermost first. */
  readonly apis: readonly { readonly id: string; readonly folders: readonly string[] }[];
}

Members#

Name Type Description
routes readonly routes: readonly MiddlewareSourceModule[] Route-level modules, keyed by route id (pages and layouts with a middleware export).
directories readonly directories: readonly MiddlewareSourceModule[] _middleware modules, keyed by folder ("" for the routes root).
pages readonly pages: readonly { readonly id: string; readonly folders: readonly string[] }[] Page route id to the folders whose _middleware applies, outermost first.
apis readonly apis: readonly { readonly id: string; readonly folders: readonly string[] }[] API route id to the folders whose _middleware applies, outermost first.