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

Todos los exports

573 páginas: una por cada export público del paquete y una por cada bloque, macro, etiqueta y directiva que reconoce el compilador de componentes. Salen del código fuente y de su JSDoc, la misma documentación que muestra el editor.

El índice de la referencia agrupa los símbolos principales por tipo, con páginas que explican su uso, sus errores comunes y sus ejemplos.

Sintaxis de .meeko

Lo que el compilador reconoce en un archivo .meeko sin importarlo: los bloques del componente, las macros del script, las etiquetas propias y las directivas de la plantilla.

Bloques del componente

  • <script server> El código de servidor de una página de app/pages, en el propio .meeko.
  • generic Atributo del <script lang="ts"> que declara parámetros de tipo del componente.
  • <style> Estilos globales que viven junto al componente.
  • <style scoped> Estilos con ámbito del componente.

Macros del compilador

  • defineProps Macro de compilación: declara las props del componente con el tipo T y devuelve el objeto de props.
  • defineEmits Macro de compilación: declara los eventos del componente.
  • defineModel Macro de compilación: declara un modelo, una señal escribible que el padre comparte con model="señal" (el modelo sin nombre) o model:nombre="señal".
  • defineSnippets Macro de compilación: declara los snippets del componente, contenido de plantilla que el padre escribe entre las etiquetas del hijo.
  • defineExpose Macro de compilación: publica exposed para el padre que nombra este componente con ref: y lo lee con useElementRef.
  • useElementRef Macro de compilación: lee el elemento o el componente que la plantilla nombra con ref:nombre.

Etiquetas propias

  • <MeekoLink> Renderiza un <a> cuyo href construye href():
  • <MeekoOutlet /> Pinta, en app/app.meeko y en los layouts (app/layouts/*.meeko o +layout.meeko), el layout o la página que van dentro.
  • <MeekoThemeToggle> Obsoleto desde 1.8; retirada en 2.0. Usa <UIThemeToggle> de @meekojs/ui 0.2 con su módulo activo.
  • <MeekoAwait> Zona de unos datos que llegan después del primer pintado:
  • <MeekoTeleport> Pinta su contenido en otro lugar del documento sin sacarlo del componente que lo declara:
  • <MeekoPopover> Obsoleto desde 1.8; retirada en 2.0. Usa <UIPopover> de @meekojs/ui 0.2 con su módulo activo.
  • <MeekoSelect> Obsoleto desde 1.8; retirada en 2.0. Usa <UISelect> de @meekojs/ui 0.2 con su módulo activo.
  • <component is> Renderiza un componente.
  • <snippet> Llena un snippet con nombre de un componente hijo que lo declara con defineSnippets.
  • <render> Pinta, en el hijo, un snippet que le pasa el padre, con esos argumentos.

Directivas de la plantilla

  • {expresión} Texto con el valor de una expresión TypeScript, escapado.
  • if:when Pasa el snippet sólo mientras la expresión es verdadera; el hijo debe declararlo opcional.
  • each:of Repite la etiqueta por cada elemento de la lista.
  • on:evento Manejador de un evento.
  • bind:nombre Atributo o prop con el valor de una expresión.
  • model Enlaza en los dos sentidos un control de formulario con una señal:
  • html Inserta la expresión como HTML sin escapar.
  • ref:nombre Referencia a la etiqueta para useElementRef.

@meekojs/meeko

El motor de componentes: señales, efectos, ciclo de vida, contexto, observador de errores, serialización y los tipos de componentes, snippets y DevTools.

Funciones

  • batch Agrupa varias escrituras en una sola ronda de notificaciones, al terminar fn.
  • computed Deriva un valor de otras señales y lo recalcula cuando cambian.
  • createContext Crea una clave de contexto única.
  • createRoot Crea una raíz reactiva: los efectos, limpiezas y valores de contexto creados dentro de fn pertenecen a ella y se liberan al llamar a dispose.
  • effect Ejecuta fn ahora y cada vez que cambia una señal que leyó.
  • inject Lee el valor del proveedor más cercano.
  • isTooLargeToAnimate Indica si un documento es demasiado grande para animarlo con una View Transition:
  • onCleanup Registra en la raíz activa la liberación síncrona de un recurso externo.
  • onMounted Ejecuta fn una vez en el navegador, después de que el componente se hidrate o se monte, con sus bindings y refs ya asignados.
  • provide Publica un valor en la instancia activa y sus descendientes.
  • provideErrorHandler Registra un observador de errores para este componente y sus descendientes:
  • serializeJson Serializa props y estado para enviarlos al navegador dentro de una etiqueta <script>.
  • signal Crea un valor observable y editable.
  • trustHtml Declara que html es HTML de confianza y lo devuelve con el tipo TrustedHtml, que la directiva html="expresión" acepta sin avisar (MEEK107).
  • untrack Ejecuta fn leyendo señales sin registrarlas como dependencias del observador activo.
  • useId Devuelve un ID único para atributos como id, for, aria-describedby o aria-controls, el mismo en el HTML del servidor y al hidratar en el navegador.

Interfaces

  • ComponentModule Contrato de un módulo de componente compilado para componerlo sin elemento envolvente.
  • ComponentRegistry Project component modules registered by Meeko.
  • ComponentRelease Función que libera una instancia hidratada:
  • DevtoolsActivity Metadatos de navegación o carga; no contienen URLs, parámetros, cabeceras ni valores del usuario.
  • DevtoolsAssignmentSite Asignación .value del archivo .meeko que escribió una señal.
  • DevtoolsEditSite Escritura solicitada desde un panel mediante setSignal.
  • DevtoolsEvent Cambio reciente del árbol de componentes o de una señal en la línea de tiempo.
  • DevtoolsHook Interfaz pública que consume una extensión o un panel de desarrollo, disponible en desarrollo como window.__MEEKO_DEVTOOLS__.
  • DevtoolsInstance Estado serializable de una instancia hidratada:
  • DevtoolsReadSite Ubicación de una expresión que lee una señal durante desarrollo; línea y columna empiezan en 1.
  • DevtoolsRegistration Datos que entrega un componente compilado al registrarse en DevTools cuando se hidrata en desarrollo.
  • DevtoolsSignalSite Declaración de una señal en su archivo .meeko; línea y columna empiezan en 1.
  • DevtoolsSnapshot Captura del estado de DevTools, independiente de referencias DOM y de valores no serializables.
  • DomScope Fragmento de DOM que pertenece a una instancia o a una región dinámica:
  • ReadonlySignal Señal de sólo lectura: leer value dentro de un effect, un computed o la plantilla registra la dependencia.
  • Signal Señal editable: escribir value notifica a los observadores que la leyeron, salvo que el valor sea igual (Object.is).
  • Snippet Contenido de plantilla que un padre pasa a un hijo y que el hijo coloca con <render>.

Tipos

  • AttributeValueOf Valor de un atributo HTML del elemento Tag:
  • AttributeValues Valores que el estándar HTML admite en el atributo Name de la etiqueta Tag, como unión de literales:
  • Component Componente compilado que puede transferir su estado durante SSR.
  • ComponentArgs Correlated name and props pairs for dynamic APIs.
  • ComponentErrorHandler Observador de fallos de la raíz actual y sus descendientes.
  • ComponentName Names of the components discovered for the current project.
  • ComponentOf The original renderable module for a registered component, including its public exports.
  • ComponentProps Input props of the module's actual renderToString contract.
  • ContextKey Clave nominal para compartir un valor tipado entre instancias anidadas con provide e inject.
  • DevtoolsCommandResult Resultado de una orden que puede rechazarse sin lanzar excepciones a través del puente.
  • DevtoolsEventKind Tipos de evento de la línea de tiempo.
  • DevtoolsProtocolVersion Versión del protocolo expuesta por el hook y por cada captura.
  • DevtoolsReadKind Construcción de la plantilla o del script que lee una señal.
  • DevtoolsValue Valor serializable que transporta una captura al panel:
  • DevtoolsWriteSite Origen conocido de la escritura que produjo un evento de señal.
  • ElementAttributes Atributos que acepta bind="obj" en un elemento Tag:
  • ErrorSource Dónde se observó un fallo del navegador: un handler on: ("event"), un effect, una limpieza, onMounted o la continuación de un setup con await ("mounted", desde 1.1), la navegación o un cliente Socket.
  • HotState Valores de las señales editables de un componente, por nombre, que HMR transfiere en memoria entre dos versiones del módulo.
  • ResolvedComponent A registered component with its props already supplied to resolveComponent(name, props).
  • TagName Etiqueta HTML que <component is> puede renderizar:
  • TrustedHtml Un string de HTML que el código declaró de confianza con trustHtml:

@meekojs/meeko/framework

La aplicación: configuración, módulos y plugins, rutas y páginas, navegación, head del documento, estado, formularios y almacenamiento, y los clientes de API, RPC y Socket.

Funciones

  • createApiClient Crea un cliente de API a partir de los descriptores públicos, sin importar código del servidor.
  • createBrowserClientOptions Opciones de cliente para el navegador: leen el token CSRF de la meta meeko-csrf-token en cada llamada, también tras navegar, y la actualizan con la cabecera x-meeko-csrf-token de las respuestas, salvo que el documento o el token hayan cambiado durante la petición.
  • createNavigator Crea un navegador de cliente para un host propio:
  • createPublicServerManifest Quita del manifiesto descubierto del servidor las rutas privadas de los handlers, para poder serializarlo y enviarlo al navegador.
  • createRouteManifest Crea un manifiesto de rutas inmutable: comprueba que no haya dos rutas con la misma forma de URL y ordena las estáticas antes que las de parámetros y los catch-all.
  • createRpcClient Crea un cliente RPC a partir de los descriptores públicos.
  • createSocketClient Crea un cliente Socket de bajo nivel sobre el WebSocket nativo, sin cola sin conexión ni reenvío automático.
  • createSocketRegistry Crea un registro de clientes Socket tipados por canal, que se conectan al leer cada canal.
  • createUseApi Crea useApi para los endpoints GET de un manifiesto público.
  • createUseApiMutation Crea useApiMutation para los endpoints POST, PUT, PATCH y DELETE de un manifiesto público, como hacen los clientes generados.
  • createUseRpcMutation Crea useRpcMutation para los procedimientos de un manifiesto público, como hacen los clientes generados.
  • createUseRpcQuery Crea useRpcQuery para los procedimientos de un manifiesto público, como hacen los clientes generados.
  • defer Marca un dato del loader que puede llegar después de la página.
  • defineGroup Declara las opciones de una carpeta de app/pages en su +group.ts:
  • defineMeekoConfig Declara la configuración de meeko.config.ts con sus tipos.
  • defineMeekoModule Declara un módulo de Meeko.
  • definePage Declara las opciones de ruta de una página y conserva la inferencia de tipos entre los schemas, load y head.
  • definePlugin Declara un plugin de aplicación.
  • defineRouteMiddleware Declara el middleware de ruta que exporta por defecto un archivo de app/middleware/.
  • defineServerRouteMiddleware Declara el middleware de ruta de servidor que exporta por defecto un archivo app/middleware/*.server.ts (se autoimporta en los *.server.ts y en server/); otro export por defecto, o ninguno, detiene el descubrimiento.
  • documentHtml Declara que un HTML de confianza sólo necesita viajar una vez:
  • href Construye una URL comprobada con el manifiesto de la aplicación en ejecución:
  • isClientError Comprueba si error es un ClientError y, con code, si tiene ese código.
  • matchRoute Busca la ruta de una URL en el mismo manifiesto que usan SSR y la navegación de cliente.
  • mountClientApp Hidrata el árbol SSR de la aplicación y gestiona la navegación de cliente:
  • notFound Detiene el código de nivel superior de servidor de la página y renderiza la página de error más cercana con estado 404.
  • redirect Detiene el código de nivel superior de servidor de la página y responde con una redirección.
  • sitemapXml Escribe un sitemap (protocolo sitemaps.org 0.9) con URL absolutas:
  • useForm Crea el estado de un formulario: una señal por campo para model, validación con un Standard Schema (Valibot) al enviar, los issues de un 400 del servidor llevados a cada campo, un mensaje del formulario, pending, submitted, dirty, reset y load.
  • useHead Añade etiquetas al <head> del documento y atributos a <html> y <body> mientras el componente que la llama está montado.
  • useLayout Da acceso a las props del layout con nombre de la página desde su <script> (y desde sus componentes y sus +layout.meeko).
  • useNavigation Lee el estado de navegación de la aplicación actual.
  • usePage Devuelve la petición de la página cuyo código de nivel superior de <script server> se está ejecutando.
  • useRoute Lee la ruta confirmada de la aplicación actual:
  • useSeoMeta Atajo tipado de useHead para SEO:
  • useSocketChannel Abre el canal name de un registro de contratos ligado a la raíz del componente actual, como useSocketClient.
  • useSocketClient Crea un cliente Socket ligado a la raíz del componente actual, que se cierra al desmontarlo.
  • useState Devuelve la señal de estado de la aplicación con clave key, creada con factory() la primera vez.
  • useStorage Devuelve una señal editable cuyo valor se guarda como JSON en localStorage (o en sessionStorage con storage: "session") bajo key.
  • useTheme Devuelve el tema de la aplicación: theme, la elección (editable, "system" incluido), resolved, el tema efectivo, themes y set(theme).
  • useThemeToggle Devuelve lo que necesita un selector de tema propio, como <UIThemeToggle> de @meekojs/ui:

Clases

  • ClientError Error que lanzan los clientes de API y RPC ante una respuesta no correcta.
  • PageInputError Error de validación de params o search de una página contra sus schemas.
  • StateStore Almacén del estado de useState: una señal por clave, serializable en JSON.

Constantes

  • useSocket obsoleto Alias obsoleto de useSocketClient:

Interfaces

  • ApiMutation Resultado de useApiMutation(ruta, método):
  • ApiOperation Declaración de tipos de una operación de API, que el contrato generado infiere de los schemas públicos de shared/.
  • AwaitMessages Textos de <MeekoAwait> cuando no recibe el snippet error, para traducirlos con bind:messages.
  • AwaitResource Lo que <MeekoAwait for="…"> espera: el resultado de useApi o useRpcQuery (sin await), o cualquier objeto con la misma forma.
  • ClientApp Aplicación montada que devuelve mountClientApp.
  • ClientAppOptions Opciones de mountClientApp.
  • ClientComponent Forma pública de un módulo .meeko compilado que necesita mountClientApp para renderizar e hidratar páginas y layouts.
  • ClientOptions Opciones de transporte de los clientes de API y RPC y de los composables de datos.
  • ClientPageDefinition Opciones de ruta de una página que se renderiza en el navegador (render: "client").
  • ClientPageLoadContext Contexto del loader de una página render: "client", que se ejecuta en el navegador sin request ni context.
  • ClientRoute Opciones de ruta que se ejecutan en el navegador:
  • DataResource Datos reactivos que devuelven useApi y useRpcQuery.
  • DataResourceOptions Opciones de recarga de useApi y useRpcQuery:
  • DeferOptions Opciones de defer.
  • Deferred Valor del loader que puede llegar después de la página.
  • DeferredError Fallo público de un valor diferido.
  • DocumentConfig Documento de la aplicación: document de meeko.config.ts.
  • DocumentHead head de DocumentConfig y de meeko.addHead en los módulos:
  • DocumentSeo Opciones de document.seo: cada etiqueta derivada se puede desactivar.
  • ErrorPageRecord Página de error de la aplicación (app/error.meeko) y los layouts raíz que la rodean.
  • Form Estado de un formulario que devuelve useForm.
  • FormField Un campo de un Form, como lo devuelve form.field(name):
  • GeneratedLayouts Layouts con nombre de la aplicación, con las props de cada uno.
  • GeneratedPageLayouts Layout con nombre de cada página, por ID de ruta:
  • GeneratedRouteMiddleware Middleware de ruta con nombre de la aplicación (app/middleware/*.ts con defineRouteMiddleware(fn, { global: false })), por nombre, con su archivo.
  • GeneratedRoutes Rutas de la aplicación con sus parámetros, por ID.
  • GeneratedTheme Temas de la aplicación.
  • GroupDefinition Opciones de un +group.ts, que heredan las páginas de su carpeta y de sus subcarpetas.
  • HeadInput Lo que una configuración, un layout, una página o un componente aporta al <head> del documento y a los atributos de <html> y <body>.
  • HeadLink Etiqueta <link> de HeadInput.
  • HeadMeta Etiqueta <meta> de HeadInput.
  • HeadScript Etiqueta <script> de HeadInput:
  • HeadStyle Etiqueta <style> de HeadInput.
  • LayoutHandle Lo que devuelve useLayout: las props del layout con nombre de la página, para leerlas y cambiarlas desde el <script> de la página.
  • LinkResolveInput Enlace que recibe un LinkResolver:
  • LoadedResource Recurso esperado con await: sus datos ya se cargaron, así que data nunca es null.
  • MeekoAwaitProps Props de la etiqueta propia <MeekoAwait>, la zona de unos datos que llegan después del primer pintado (useApi o useRpcQuery sin await).
  • MeekoConfig Configuración de proyecto de meeko.config.ts.
  • MeekoDevtoolsConfig Opciones de devtools en meeko.config.ts.
  • MeekoHookable Registro de hooks de MeekoModuleContext.
  • MeekoHooks Hooks de build que un módulo registra con meeko.hooks.hook(nombre, handler).
  • MeekoLinkProps Props de la etiqueta propia <MeekoLink>, que renderiza un <a> cuyo href construye href.
  • MeekoModule Módulo de Meeko creado con defineMeekoModule:
  • MeekoModuleContext Objeto meeko que recibe setup de un módulo, en Node, durante meeko dev, meeko build y meeko check (y en el servidor de lenguaje de un workspace de confianza).
  • MeekoModuleDefinition Definición que recibe defineMeekoModule.
  • MeekoModuleMeta Identidad de un módulo de Meeko: su nombre, la clave de sus opciones en meeko.config.ts y la versión de Meeko que necesita.
  • MeekoModuleNames Nombres de los módulos de Meeko instalados en el proyecto, como claves.
  • MeekoOutletProps Props de la etiqueta propia <MeekoOutlet />:
  • MeekoPlugin Plugin de aplicación creado con definePlugin:
  • MeekoPopoverProps Props de la etiqueta propia <MeekoPopover>:
  • MeekoSelectProps Props de la etiqueta propia <MeekoSelect>, un select accesible sobre <MeekoPopover>.
  • MeekoTeleportProps Props de la etiqueta propia <MeekoTeleport>, que pinta su contenido (el snippet default) en otro lugar del documento sin sacarlo del componente que lo declara:
  • MeekoThemeToggleProps Props de la etiqueta propia <MeekoThemeToggle>, el selector de tema que Meeko compila y distribuye con theme en meeko.config.ts.
  • ModuleAutoImport Archivo de autoimport que añade un módulo con meeko.addAutoImports.
  • ModulePlugin Plugin de aplicación que añade un módulo con meeko.addPlugin.
  • ModulePublicFileOptions Opciones de addPublicFile.
  • ModuleServerHandler Handler HTTP de servidor que añade un módulo con meeko.addServerHandler.
  • MutationAttempt Un intento de una mutación que terminó, tal como lo reciben onSuccess y onError.
  • MutationFailure Un intento que falló, tal como lo recibe onError.
  • MutationOptions Opciones de useRpcMutation y useApiMutation.
  • NamedLayoutRecord Layout con nombre de una ruta o de la página de error:
  • NavigationContext Lo que recibe el callback de render de createNavigator en cada navegación.
  • NavigationState Estado de navegación de la aplicación del navegador que renderiza un componente.
  • Navigator Navegador de bajo nivel que devuelve createNavigator.
  • PageCache Caché HTTP de una página que se renderiza en el servidor (definePage({ cache })).
  • PageCacheContext Contexto que recibe cache.etag de una página, antes del loader y del render:
  • PageDefinition Opciones de ruta de una página que se renderiza en el servidor ("ssr", el modo por defecto, "stream" o "prerender").
  • PageHead Metadatos del documento que devuelve el head de una página.
  • PageLoadContext Contexto que reciben load y head de una página renderizada en el servidor.
  • PageMemoryCache Límites de la caché en memoria de una página (cache.memory), por ruta y por proceso.
  • PageRequest Petición para la que se ejecuta el código de nivel superior del <script server> de una página, tal como la devuelve usePage().
  • PageSchema Subconjunto de Standard Schema v1 que se puede usar en el navegador, como el que implementan los schemas de Valibot.
  • PluginApp Aplicación que recibe un plugin de app/plugins (o de un módulo) al arrancar.
  • PluginRegistration Plugin con sus opciones, tal como lo listan las entradas generadas.
  • PopoverExposed Lo que <MeekoPopover> expone a una ref: del padre:
  • PopoverSnippets Snippets de <MeekoPopover>: el contenido suelto (default) va dentro del elemento con popover; trigger es el contenido del <button> disparador que pinta Meeko, y anchor sustituye ese botón por un disparador propio, con sus atributos en el parámetro.
  • PopoverToggleEvent Detalle del evento toggle de <MeekoPopover>, que se emite cada vez que el contenido se abre o se cierra, por el usuario o por el modelo.
  • PopoverTrigger Atributos del disparador propio de <MeekoPopover>, el parámetro trigger del snippet anchor.
  • PublicApiEndpoint Descriptor público de un endpoint de API.
  • PublicRpcEndpoint Descriptor público de un procedimiento RPC, sin el archivo del handler.
  • PublicServerManifest Manifiesto público del servidor: los endpoints de API y RPC que pueden llamar los clientes, sin rutas privadas.
  • RetrySafeMutation Lo que añade retrySafe a una mutación.
  • RetrySafeOptions Opciones del modo retrySafe de useRpcMutation y useApiMutation.
  • RobotsConfig Opciones de robots en meeko.config.ts:
  • RouteMatch Resultado de matchRoute:
  • RouteMiddlewareContext Contexto del middleware de ruta, que se ejecuta antes del loader en las peticiones SSR de una página con ruta y en las navegaciones del navegador.
  • RouteMiddlewareOptions Opciones de defineRouteMiddleware.
  • RouteRecord Una ruta del manifiesto que comparten el renderizador del servidor y el navegador.
  • RouteState Ruta confirmada que renderiza un componente:
  • RpcMutation Resultado de useRpcMutation(procedimiento):
  • RpcOperation Declaración de tipos de un procedimiento RPC:
  • SelectField Lo que <MeekoSelect> lee de form.field('x') de useForm:
  • SelectFilterContext Lo que recibe una función filter de <MeekoSelect> además del texto buscado.
  • SelectOptionState Estado de una opción, el segundo parámetro del snippet option.
  • SelectSnippets Snippets de <MeekoSelect>, tipados con el tipo de sus opciones.
  • SeoMetaInput Atajo tipado de useSeoMeta: cada campo produce la etiqueta correcta (name o property).
  • ServerResponseConfig Cabeceras de respuesta de los adaptadores con servidor (node, bun, deno y cloudflare).
  • ServerRouteMiddlewareContext Contexto del middleware de ruta de servidor (app/middleware/*.server.ts):
  • SitemapAlternate Versión de una URL del sitemap en otro idioma:
  • SitemapConfig Opciones de sitemap en meeko.config.ts.
  • SitemapEntriesContext Lo que recibe la función sitemapEntries de definePage.
  • SitemapEntry Una URL de una ruta en sitemap.xml, que declara sitemapEntries en definePage:
  • SitemapResolvedUrl URL de sitemap.xml que reciben los módulos en el hook sitemap:resolved:
  • SocketClient Cliente tipado de un canal Socket.
  • SocketClientOptions Opciones de createSocketClient y useSocketClient.
  • SocketContract Contrato público de un canal Socket: los schemas de cada evento en cada dirección.
  • SocketRegistryOptions Opciones de createSocketRegistry y useSocketChannel, además de las del cliente.
  • SocketSchema Subconjunto de Standard Schema v1 que valida los payloads de un evento Socket, como los schemas de Valibot de shared/schemas.
  • StorageOptions Opciones de useStorage.
  • ThemeConfig Opciones de theme en meeko.config.ts.
  • ThemeState Lo que devuelve useTheme: la elección, el tema efectivo y la lista de temas.
  • ThemeToggleMessages Textos accesibles de <MeekoThemeToggle> además de los nombres de los temas (labels), para traducirlos.
  • ThemeToggleState Lo que devuelve useThemeToggle: lo que necesita un selector de tema propio para pintar lo mismo en SSR y en la hidratación y para cambiar el tema sin JavaScript con el formulario de POST /_meeko/theme.
  • ThemeToggleSystem Temas que muestra la elección "system" en ThemeToggleState.
  • UncertainMutation Una intención enviada sin respuesta: el servidor pudo aplicarla o no.
  • ValidationIssue Un mensaje del schema sobre un campo de la entrada que el servidor rechazó con 400 (INVALID_PARAMS, INVALID_QUERY, INVALID_BODY o INVALID_INPUT).

Tipos

  • ApiClient Cliente de API tipado: un árbol según clientKey con un método por verbo HTTP.
  • ApiMutationContract Operaciones de escritura (POST, PUT, PATCH, DELETE) de un contrato de API indexadas por ruta y método (["/api/notes"]["POST"]), a partir del manifiesto público.
  • ApiMutationInput Entrada de una operación de API que no es GET, sin signal:
  • ApiQueryContract Operaciones GET de un contrato de API indexadas por ruta ("/api/users/[id]"), a partir del manifiesto público de la aplicación.
  • ApiQueryOptions Opciones de useApi para una operación GET:
  • DeferredFactory Fábrica de un valor diferido: Meeko la llama cuando el loader devuelve.
  • DeferredStatus Estado de un valor devuelto con defer.
  • FormSubmission Cómo terminó un envío de Form.trySubmit:
  • JsonShape Forma serializable en JSON de T.
  • LayoutName Nombre de un layout con nombre de la aplicación (app/layouts/<nombre>.meeko, los de los layers y los de meeko.addLayout):
  • LayoutProps Props que una página puede pasar al layout con nombre L:
  • LayoutPropsInput Valor de layoutProps: las props del layout L o, en las opciones de ruta, una función que las calcula con el contexto de la página (data incluido), como head.
  • LinkResolver Resolvedor de enlaces que un plugin registra con app.resolveLink:
  • MeekoAwaitSnippets Snippets de <MeekoAwait>.
  • MeekoModuleEntry Una entrada de modules en meeko.config.ts.
  • MeekoModuleName Nombre de un módulo en modules: un paquete instalado ("@meekojs/i18n") o una ruta a un módulo del proyecto ("./modules/hello").
  • MeekoTeleportTarget Destino de <MeekoTeleport to>: "body", el final de <body>, o "#id", el elemento con ese id.
  • PageBodyDefinePage definePage tal como lo ven meeko check y el editor en una página con código de nivel superior en <script server>:
  • PageBodyHead Tipo de export const head en el código de nivel superior de un <script server>:
  • PageBodyLayoutProps Comprobación de export const layoutProps en el código de nivel superior de un <script server>, que meeko check y el editor aplican:
  • PageLayout Layout con nombre de la página cuyo ID de ruta es Id, tal como lo resuelven su definePage y los +group.ts de sus carpetas:
  • PageLayoutOptions Opciones de layout de las opciones de ruta (definePage):
  • PageRender Cómo llega una página al navegador: - "ssr" (por defecto):
  • PageRequestOf Tipo de usePage() en una página cuyas opciones de ruta son Route y cuyo ID de ruta es Id:
  • PluginErrorHandler Observador de errores que registra un plugin con PluginApp.onError.
  • PluginErrorInfo Dónde se observó un fallo que recibe un PluginErrorHandler:
  • PopoverMode Comportamiento del contenido, el valor de su atributo popover:
  • PopoverPlacement Posición del contenido respecto al disparador:
  • PopoverRole Patrón ARIA del contenido: "menu" (con menuitem, flechas y búsqueda por letras), "dialog" (el foco entra en el contenido) o "tooltip" (por defecto con mode="hint").
  • Reactive Un valor o una señal de ese valor.
  • RouteId ID de cualquier ruta de la aplicación, como "/users/[id]":
  • RouteMiddleware Middleware de ruta: devolver undefined continúa y devolver un Response detiene la ruta.
  • RouteMiddlewareName Nombre de un middleware de ruta con nombre de la aplicación (app/middleware/auth.ts con { global: false } es "auth"):
  • RpcClient Cliente RPC tipado: un árbol de funciones según el ID de cada procedimiento (rpc.users.get(input, { signal })), que devuelven su salida o rechazan con ClientError.
  • SelectFilter Búsqueda propia de <MeekoSelect searchable>:
  • SelectModel Valor del modelo de <MeekoSelect>: la opción elegida o null y, con multiple, un array de opciones.
  • SerializableExport Comprobación de tipos que falla cuando un export del código de nivel superior de servidor no se puede serializar en JSON.
  • ServerData Cómo ven el <script> y la plantilla de una página un export de su código de nivel superior de servidor:
  • ServerHeaders Cabeceras de las respuestas de un adaptador con servidor (server.headers).
  • ServerRouteMiddleware Middleware de ruta de servidor: devolver undefined continúa y devolver un Response detiene la ruta; redirect(), notFound() y un error la detienen como en el <script server>.
  • SocketRegistry Registro de clientes Socket por nombre de canal, como el autoimport socket.
  • StaticHeaderFile Archivo de cabeceras que escribe el adaptador static en su salida:
  • StorageArea Almacenamiento del navegador de useStorage:
  • ThemeChoice Lo que el usuario puede elegir: un ThemeName o "system" si el modo sistema está activo.
  • ThemeName Nombre de un tema de la aplicación: la unión de los themes de meeko.config.ts cuando meeko check generó sus tipos (.meeko/types/routes.d.ts); sin ellos, string.
  • ThemeToggleSnippets Snippets de <MeekoThemeToggle>: uno opcional por elección, con el icono de esa elección (<snippet name="dark"><IconMoon /></snippet>).
  • UseApi Firma de useApi(ruta, opciones?, recarga?):
  • UseApiMutation Firma de useApiMutation(ruta, método, opciones?):
  • UseRpcMutation Firma de useRpcMutation(procedimiento, opciones?):
  • UseRpcQuery Firma de useRpcQuery(procedimiento, input?, recarga?):

@meekojs/meeko/server

El servidor de la aplicación: runtime, middleware, contexto de la petición, sesiones y sus almacenes, endpoints de API y RPC, canales Socket, OpenAPI y llamadas locales.

Funciones

  • clientAddress IP del cliente de una petición (desde 1.7), con la misma política que context.clientAddress y rateLimit:
  • composeServerMiddleware Compone una lista de middleware de servidor alrededor de un handler, en orden de fuera hacia dentro.
  • contentSecurityPolicy Construye el valor de la cabecera Content-Security-Policy a partir de una política y de los hashes de los scripts en línea que ejecutan las páginas (como los de PrerenderIndex.pages[ruta].scriptHashes).
  • createFrameworkHandler Crea un handler Fetch portable que renderiza las páginas:
  • createLocalCalls Crea funciones para llamar a la API y al RPC de la aplicación dentro del proceso, con objetos Request en memoria y las credenciales de la petición original, sin red ni contexto global.
  • createLocalServerFetch Crea el despacho local que usan los clientes de servidor durante SSR:
  • createRequestContext Crea el contexto de una petición para un host propio.
  • createServerApp Crea la aplicación portable a partir del manifiesto fijado en el build y un cargador de módulos.
  • createServerClientOptions Opciones de cliente para el servidor: leen la URL, las cookies, authorization, el token CSRF y el despacho local de la petición en curso en cada llamada, así que un cliente creado a nivel de módulo nunca retiene credenciales de otro usuario.
  • createServerDispatcher Crea un handler HTTP que atiende /api/... y /_meeko/rpc/... para un host propio:
  • createServerSocketRegistry Crea el registro socket de los clientes de servidor:
  • createSocketHub Crea el hub de Socket de un host propio.
  • createSocketUpgradeHandler Handshake de Socket portable para cualquier runtime:
  • defineApiRoute Declara un endpoint de API, el export por defecto de server/api/<ruta>.<método>.ts.
  • defineRpc Declara un procedimiento RPC, el export por defecto de server/rpc/<ruta>.ts, que se llama con POST /_meeko/rpc/<ruta> y desde rpc.*.
  • defineServerMiddleware Declara el middleware de servidor que exporta por defecto un archivo de server/middleware/.
  • defineServerRuntime Declara en server/runtime.ts las sesiones, los servicios y la política de Socket de la aplicación.
  • defineSocketChannel Declara un canal Socket, el export por defecto de server/socket/<nombre>.ts.
  • dispatchApiRoute Atiende una petición de API para un host propio:
  • dispatchRpc Atiende una petición RPC para un host propio:
  • errorResponse Convierte un error en la respuesta JSON pública { code, status, requestId } con la cabecera x-request-id.
  • executeApiRoute Ejecuta un endpoint de API con sus guardas y validaciones y devuelve la respuesta JSON, o lanza un ApiError.
  • executeRpc Ejecuta un procedimiento RPC con sus guardas y validaciones y devuelve su salida validada.
  • generateOpenApi Genera un documento OpenAPI de los endpoints de API y RPC usando sólo el registro de schemas públicos que pasa el llamador.
  • handleProcessErrors Aplica a un host propio la política de fallos del proceso de server/runtime.ts (processErrors, véase ProcessErrorPolicy):
  • loadSocketChannels Carga las definiciones de los canales Socket del manifiesto, que sólo existen en el servidor.
  • openSocketSession Conecta un transporte ya actualizado al hub, con una cadena de recepción en serie.
  • useRequestState Devuelve el valor de key en el estado de la petición y lo crea con factory() la primera vez.

Clases

  • ApiError Error público de API, RPC, Socket y loaders:
  • LocalSocketPubSub Broker de una sola instancia, el que usa el hub por defecto.
  • MemorySessionStore Store de sesiones en memoria, sólo para desarrollo:
  • RedisSessionStore Store de sesiones persistente en Redis: la caducidad la gestiona Redis, replace y revokeFamily son scripts atómicos y un índice por familia localiza la sesión activa.
  • RedisSocketPubSub Reparte los broadcasts de Socket entre instancias del servidor con el pub/sub de Redis.
  • SessionHandle Sesión de una petición, en RequestContext.session:
  • SessionManager Gestor de sesiones de la aplicación: cookies opacas HttpOnly, host-only y Secure por defecto, rotación y revocación por familia, y comprobación de Origin y CSRF en las mutaciones autenticadas.
  • SessionRevokedError La familia de la sesión se revocó o su ID fue sustituido.
  • SessionSecurityError Una mutación autenticada no superó la comprobación de Origin o de CSRF.
  • SqlSessionStore Store de sesiones SQL genérico y persistente:

Interfaces

Tipos

  • ApiMethod Método HTTP de un endpoint de API, el sufijo de server/api/<ruta>.<método>.ts.
  • ApiSuccessStatus Estados de éxito que un endpoint JSON puede elegir con status (desde 1.2).
  • AppModuleLoader Resuelve una clave del manifiesto a su módulo.
  • AppServices Servicios de la aplicación: los de GeneratedServices (inferidos de server/runtime.ts) o unknown sin ellos.
  • AssetManifest Archivos públicos del build por ruta de URL, tal como la serializa la URL WHATWG.
  • ContentSecurityPolicy Política Content-Security-Policy por directiva:
  • DocumentMarkup HTML de confianza del host: fijo o derivado de la petición y su nonce CSP.
  • PlatformName Runtime de JavaScript con adaptador de servidor de Meeko.
  • RedisMessageListener Firma del listener de subscribe y sSubscribe en node-redis 4 o posterior.
  • ServerErrorObserver Observador de los fallos internos del servidor, con el ID de la petición.
  • ServerFetch Despacha una petición por el pipeline HTTP de la aplicación conservando el contexto de la petición original.
  • ServerMiddleware Middleware de servidor: envuelve las peticiones HTTP de páginas, API y RPC antes de que Meeko cree su contexto.
  • ServerModuleLoader Resuelve una clave del manifiesto a su módulo.
  • ServerRuntimeDefinition Export por defecto de server/runtime.ts:
  • ServerRuntimeServices Tipo de los servicios que devuelve una definición de runtime:
  • ServerServices Servicios de la aplicación: un objeto compartido o una función que los crea en cada petición.
  • ServerSocketRegistry Registro socket de los clientes de servidor generados (clients.server.ts):
  • SessionData Datos de la sesión de la aplicación (desde 1.2):
  • SocketUpgrade Resultado de la comprobación de política que precede al upgrade del transporte.
  • SocketUpgradeHandler Aplica la política de Socket a una petición de handshake; el framing del protocolo es cosa del adaptador.
  • Unsubscribe Cancela una suscripción; puede terminar de forma asíncrona.

@meekojs/meeko/node

Adaptador de Node.js: listener y servidor HTTP, lectura de assets y WebSocket.

Funciones

  • attachNodeWebSocketServer Conecta los canales Socket de Meeko a un servidor HTTP de Node usando ws para el protocolo.
  • createNodeAssetReader Sirve desde el disco sólo los archivos del build listados en el manifiesto, en streaming y con ETag, HEAD y 304.
  • createNodeSocketUpgradeHandler Atiende el evento upgrade de Node tras la comprobación de política.
  • serveNode Sirve una aplicación de Meeko con el servidor HTTP de Node, incluidos sus canales Socket (con ws).
  • toNodeListener Adapta un handler Fetch portable al callback del servidor HTTP de Node 24.

Interfaces

@meekojs/meeko/password

Hash y verificación de contraseñas con scrypt, sin dependencias.

Funciones

  • hashPassword Calcula el hash de una contraseña con scrypt (N = 2^17, r = 8, p = 1, sal aleatoria de 16 bytes y clave de 32 bytes) en el formato autodescriptivo scrypt$<N>$<r>$<p>$<sal>$<hash>, con la sal y el hash en base64url.
  • needsRehash Indica si un hash debe recalcularse con los parámetros actuales de hashPassword:
  • verifyPassword Comprueba una contraseña contra un hash scrypt$<N>$<r>$<p>$<sal>$<hash>, el de hashPassword o uno escrito antes con esos mismos parámetros (como scrypt$131072$8$1$… con una sal de 32 bytes y un hash de 64).

@meekojs/meeko/bun

Adaptador de Bun: servidor con WebSocket y lectura de assets.

Funciones

  • createBunAssetReader Sirve con Bun.file sólo los archivos del build listados en el manifiesto, con ETag, HEAD y 304.
  • createBunServer Sirve una aplicación de Meeko con Bun.serve, incluidos sus canales Socket con el WebSocket nativo de Bun:

Interfaces

@meekojs/meeko/deno

Adaptador de Deno: servidor y lectura de assets.

Funciones

  • createDenoAssetReader Sirve con Deno.open sólo los archivos del build listados en el manifiesto, en streaming y con ETag, HEAD y 304.
  • serveDeno Sirve una aplicación de Meeko con Deno.serve, incluidos sus canales Socket con Deno.upgradeWebSocket.

Interfaces

@meekojs/meeko/cloudflare

Adaptador de Cloudflare Workers: el worker, las salas Socket en Durable Objects, los assets, el prerender y las sesiones en D1.

Funciones

Clases

Interfaces

Tipos

  • CloudflareApp Una aplicación ya creada, o una fábrica que la crea a partir de los bindings en el primer evento de cada aislado; si falla, el siguiente evento la reintenta.
  • DurableObjectBase Clase DurableObject de cloudflare:workers, que se pasa como argumento para que este módulo se pueda cargar fuera de Workers.
  • MeekoSocketRoomClass Clase de salas de Socket que devuelve createSocketRoomClass, para exportarla desde el Worker con el nombre declarado en wrangler.jsonc.

@meekojs/meeko/build

Herramientas de build para Node: descubrimiento de rutas, configuración, prerender y builds de adaptadores. Lee el sistema de archivos y carga TypeScript.

Funciones

  • buildProject Construye el proyecto como meeko build:
  • composeFrameworkRoutes Compone las rutas del proyecto, de sus layers y de módulos programáticos en un manifiesto.
  • discoverConfiguredRoutes Descubre las rutas de la aplicación y de los layers de meeko.config.ts (también los que aportan los módulos) en un solo manifiesto.
  • discoverErrorPage Descubre app/error.meeko con los layouts raíz que lo envuelven:
  • discoverLayouts Descubre los layouts con nombre de app/layouts de un proyecto, layer o módulo:
  • discoverRouteMiddleware Descubre el middleware de ruta de app/middleware de un proyecto, también en subcarpetas, sin ejecutarlo.
  • discoverRoutes Descubre las páginas de app/pages con sus layouts, su +error.meeko más cercano y sus opciones de ruta (<script server> o sidecar *.route.ts), y lee render y, desde 1.5, layout y los +group.ts de sus carpetas sin ejecutar código.
  • discoverServerManifest Descubre de forma estática los endpoints de server/api, los procedimientos de server/rpc y los canales de server/socket, para el build y el desarrollo.
  • inlineScriptHashes Calcula el hash SHA-256 (base64) de cada <script> en línea de un documento HTML que el navegador comprueba con script-src:
  • inlineStyleHashes Calcula el hash SHA-256 (base64) de cada <style> en línea de un documento HTML, como fuentes CSP 'sha256-…' para style-src:
  • loadMeekoConfig Carga la configuración opcional del proyecto (meeko.config.ts, .mts, .js o .mjs) con el soporte de TypeScript de Node 24 y valida sus campos.
  • prerenderProject Prerenderiza las rutas render: "prerender" con el build Node existente y las escribe en .meeko/output/node/prerender.
  • prerenderRoutes Prerenderiza las rutas render: "prerender":
  • readMeekoConfigSync Lee layers, extends, modules e imports (appDirs, sharedDirs y serverDirs) de la configuración sin ejecutarla, analizando el archivo; es lo que usa el editor en un workspace no confiable.
  • resolveConfigSources Resuelve las fuentes del proyecto en orden (aplicación, extends, layers, las carpetas de layer listadas en modules y los layers que añaden los módulos con meeko.addLayer) y rechaza, antes de descubrir rutas, las que salen del proyecto, no existen, no tienen app/pages, se repiten o tienen un nombre no válido.

Interfaces

Tipos

  • MeekoAdapterName Nombre de un adaptador de build: "node", "cloudflare", "deno", "bun" o, desde 1.3, "static".
  • MeekoServerConfig Destino de ejecución de meeko build, una unión discriminada por adapter.
  • ServerHeaders Cabeceras de las respuestas de un adaptador con servidor (server.headers).
  • StaticHeaderFile Archivo de cabeceras que escribe el adaptador static en su salida:

@meekojs/meeko/vite

El plugin de Vite: compila los imports .meeko en cliente y SSR y añade HMR y CSS en desarrollo.

Funciones

  • meeko Plugin de Vite de Meeko: compila los imports .meeko en cliente y SSR, añade HMR y CSS durante el desarrollo, aplica los autoimports a .meeko y .ts, y en una aplicación del framework genera los módulos virtuales de rutas, páginas y servidor y el módulo de cada <script server>.

@meekojs/meeko/prettier

El plugin de Prettier para .meeko: script, <script server>, plantilla y estilo.

Constantes

  • default Plugin de Prettier para componentes .meeko.
  • languages Lenguaje .meeko que el plugin registra en Prettier, con el parser meeko y la extensión .meeko.
  • options Opciones propias del plugin para Prettier:
  • parsers Parsers del plugin: meeko para archivos completos y el interno de la plantilla.
  • printers Printers del plugin: meeko imprime cada sección del componente y delega el script, el estilo y la plantilla en los printers de TypeScript, CSS y HTML de Prettier.

Interfaces

@meekojs/meeko/postcss

El plugin de PostCSS de las utilidades de CSS: @utilities y defineUtilities.

Funciones

  • default Plugin de PostCSS que expande @utilities "<ruta>" [layer(<nombre>)]; con las reglas que genera la función exportada por un módulo .ts, .mts, .js o .mjs.
  • defineUtilities Declara el export por defecto de un módulo de @utilities con tipos para los helpers.
  • meekoUtilities Plugin de PostCSS que expande @utilities "<ruta>" [layer(<nombre>)]; con las reglas que genera la función exportada por un módulo .ts, .mts, .js o .mjs.

Interfaces

Tipos

  • UtilityFunction La función que exporta por defecto un módulo de @utilities.
  • UtilityNode Un nodo que devuelven los helpers de UtilityHelpers.
  • UtilityOutput Lo que devuelve una función de utilidades:
  • UtilityValue Valor de una declaración generada: una cadena se escribe tal cual (puede llevar !important) y un número se convierte a texto sin añadir unidades (opacity: 0.5, z-index: 10; escriba "4px" para longitudes).

@meekojs/meeko/devtools-ui

El panel de DevTools que se monta dentro de la página.

Funciones

Interfaces

Tipos

@meekojs/meeko/compiler

Los exports de @meekojs/meeko/compiler.

Funciones

Constantes

  • builtinComponentModules Meeko's own components that live in a module of their own (<MeekoThemeToggle> since 1.4, <MeekoAwait>, <MeekoPopover> and <MeekoSelect> since 1.5):
  • deprecatedBuiltinTags Meeko's own tags deprecated since 1.8 and their replacement in @meekojs/ui, for the MEEK121 warning.
  • linkComponentModule <MeekoLink> as a component of its own (since 1.8), for resolveComponent("MeekoLink") and the component registry.

Interfaces

@meekojs/meeko/parse

Los exports de @meekojs/meeko/parse.

Funciones

  • attributeValueStart Devuelve la posición absoluta donde empieza el valor de un atributo, con o sin comillas.
  • decodeTemplateText Decodifica un tramo crudo de un nodo de texto como lo hace el parser HTML:
  • isCustomElementTag A custom element (<x-markdown>): its name has a hyphen.
  • isSelfClosableElement Indica si <name />, en minúsculas, es desde 1.8 un elemento HTML sin contenido equivalente a <name></name>:
  • locate Convierte un desplazamiento UTF-16 en línea y columna, empezando en uno.
  • maskComponentTags Prepara las etiquetas de componente (<AppButton>, nombre que empieza por mayúscula) para el parser HTML sin mover ninguna posición.
  • parseSfc Analiza y valida las secciones superiores de un archivo .meeko.
  • parseTemplate Analiza HTML y entrega un AST independiente del parser con posiciones originales.
  • scanInterpolations Localiza expresiones {...} de un texto de plantilla respetando llaves anidadas, cadenas, plantillas literales con ${...}, comentarios y expresiones regulares de JavaScript.

Clases

Interfaces

@meekojs/meeko/i18n

Los exports de @meekojs/meeko/i18n.

Funciones

  • createI18n Builds one request or tab translator; formatter instances are cached per options.
  • localeOf Locale of a URL path; an unprefixed path uses the configured default.
  • localizedPath
  • useI18n Reads the translator installed by the i18n module for this render root.

Constantes

Interfaces

@meekojs/meeko/i18n/module

Los exports de @meekojs/meeko/i18n/module.

Constantes

¿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/docs-content/src/content/api-groups.ts