Saltar al contenido
Meeko
Escribe para buscar en las guías y en la referencia de la API. Ábrela desde cualquier página con / o Ctrl K; muévete con las flechas y entra con Intro.
Empezar

Contenidos

En esta página

RouteRecord

interfaz

Una ruta del manifiesto que comparten el renderizador del servidor y el navegador. Lo produce discoverRoutes de @meekojs/meeko/build.

ts
import type { RouteRecord } from "@meekojs/meeko/framework";

Código fuente src/app/runtime/router.ts:22

Declaración #

ts
interface RouteRecord {
	readonly id: string
	readonly file: string
	readonly layouts: readonly string[]
	readonly error?: string
	readonly sidecar?: string
	readonly render?: PageRender
	readonly layout?: NamedLayoutRecord
	readonly middleware?: readonly string[]
	readonly serverMiddleware?: readonly string[]
}

Ejemplo #

ts
import type { RouteRecord } from "@meekojs/meeko/framework";

const route: RouteRecord = {
  id: "/users/[id]",
  file: "app/pages/users/[id].meeko",
  layouts: ["app/app.meeko", "app/layouts/default.meeko"],
  error: "app/pages/+error.meeko",
};

Propiedades #

id #

propiedad sólo lectura

readonly id: string

ID de la ruta: /, /users/[id] o /docs/[...slug].

file #

propiedad sólo lectura

readonly file: string

Archivo .meeko de la página.

layouts #

propiedad sólo lectura

readonly layouts: readonly string[]

Cadena de layouts, de fuera hacia dentro.

error #

propiedad sólo lectura opcional

readonly error?: string

+error.meeko más cercano, si existe.

sidecar #

propiedad sólo lectura opcional

readonly sidecar?: string

Módulo que exporta las opciones de ruta: un archivo *.route.ts o, en una página con <script server>, el ID de módulo <página>.meeko?meeko-route&lang.ts, que sólo carga el plugin de Vite de Meeko. No siempre es una ruta de archivo.

render #

propiedad sólo lectura opcional

readonly render?: PageRender

Modo de render leído estáticamente del sidecar al descubrir la ruta; sin él, SSR.

layout #

propiedad sólo lectura opcional desde 1.5.0

readonly layout?: NamedLayoutRecord

Layout con nombre de app/layouts que envuelve la página, con su archivo (que también está en RouteRecord.layouts) y las layoutProps de los +group.ts de sus carpetas. Sin él, la página no tiene layout con nombre (layout: false, o sin app/layouts/default.meeko).

middleware #

propiedad sólo lectura opcional desde 1.6.0

readonly middleware?: readonly string[]

Archivos de los middleware con nombre de la ruta (defineRouteMiddleware(fn, { global: false })), en el orden en que se ejecutan después de los globales: los de sus +group.ts, de fuera hacia dentro, y los de la página, sin repetir. Sin él, la ruta sólo ejecuta los globales.

serverMiddleware #

propiedad sólo lectura opcional desde 1.6.0

readonly serverMiddleware?: readonly string[]

Archivos de todos los middleware de ruta de servidor de la ruta (app/middleware/*.server.ts, con defineServerRouteMiddleware), en el orden en que se ejecutan en el servidor: los globales y después los con nombre, con la misma herencia que RouteRecord.middleware. A diferencia de middleware, es la cadena completa, para que un host sin cargador falle en lugar de saltarse los globales. Las rutas render: "client" y "prerender" no lo llevan, y el manifiesto del navegador tampoco.

Véase también #

¿Te sirvió esta página?

Añadir un comentario

Se envía al elegir «Sí» o «No». Solo se guardan la página, tu respuesta y el comentario: ni cookies ni datos tuyos.

0 de 2000 caracteres

Editar en GitHub: packages/meeko/src/app/runtime/router.ts