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

PageRoute

interfaz

Opciones de ruta tal como las carga el servidor desde <script server> o un sidecar: la forma sin tipos genéricos de definePage.

ts
import type { PageRoute } from "@meekojs/meeko/server";

Código fuente src/server/runtime/framework-render.ts:111

Declaración #

ts
interface PageRoute {
	params?: PageSchema
	search?: PageSchema
	load?: (context: PageRequestContext) => Promise<unknown> | unknown
	head?: (context: PageRequestContext & { data: unknown }) => PageHead
	render?: PageRender
	prerenderEntries?: readonly Readonly<Record<string, string>>[] | (() => Promise<readonly Readonly<Record<string, string>>[]>)
	layout?: unknown
	layoutProps?: unknown
	middleware?: unknown
	cache?: PageCache<undefined, undefined, RequestContext>
}

Ejemplo #

ts
import type { PageRoute } from "@meekojs/meeko/server";

const loadRoute = async (file: string): Promise<PageRoute> => {
  const module = await import(file) as { route?: PageRoute; default?: PageRoute };
  return module.route ?? module.default ?? {};
};

Propiedades #

params #

propiedad opcional

params?: PageSchema

Schema de los parámetros de la ruta.

propiedad opcional

search?: PageSchema

Schema de los parámetros de búsqueda.

load #

propiedad opcional

load?: (context: PageRequestContext) => Promise<unknown> | unknown

Loader del servidor.

propiedad opcional

head?: (context: PageRequestContext & { data: unknown }) => PageHead

Calcula el title con los datos del loader.

render #

propiedad opcional

render?: PageRender

Modo de render.

prerenderEntries #

propiedad opcional

prerenderEntries?: readonly Readonly<Record<string, string>>[] | (() => Promise<readonly Readonly<Record<string, string>>[]>)

Parámetros de cada URL que se prerenderiza.

layout #

propiedad opcional desde 1.5.0

layout?: unknown

Layout con nombre de la página, o false; meeko build lo lee del archivo y lo deja en el manifiesto.

layoutProps #

propiedad opcional desde 1.5.0

layoutProps?: unknown

Props del layout: un objeto o una función del contexto de head.

middleware #

propiedad opcional desde 1.6.0

middleware?: unknown

Middleware con nombre de la página, o false; meeko build lo lee del archivo y lo deja en el manifiesto. Un nombre que el manifiesto de la ruta no lista hace fallar la petición.

cache #

propiedad opcional desde 1.7.0

cache?: PageCache<undefined, undefined, RequestContext>

Caché HTTP de la página (ETag, 304, max-age y caché en memoria), que el servidor lee al ejecutar la ruta. Sólo se aplica en producción y a peticiones sin sesión.

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/server/runtime/framework-render.ts