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

MeekoModuleMeta

interfaz Desde 1.2.0

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.

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

Código fuente src/modules/define-meeko-module.ts:20

Declaración #

ts
interface MeekoModuleMeta {
	readonly name: string
	readonly configKey?: string
	readonly compatibility?: { readonly meeko?: string }
}

Ejemplo #

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

const meta: MeekoModuleMeta = { name: "@acme/seo", configKey: "seo", compatibility: { meeko: ">=1.2" } };

Propiedades #

name #

propiedad sólo lectura

readonly name: string

Nombre único del módulo, como el de su paquete. Dos módulos con el mismo nombre son un error.

configKey #

propiedad sólo lectura opcional

readonly configKey?: string

Campo de meeko.config.ts con las opciones del módulo, como "seo" para seo: { … }. Es la única forma documentada de pasarle opciones desde 1.8; para tiparla, el módulo amplía MeekoConfig (declare module "@meekojs/meeko/framework" { interface MeekoConfig { … } }) y Meeko carga esa ampliación sola en .meeko/types/config.d.ts. Dos módulos no pueden compartirla.

compatibility #

propiedad sólo lectura opcional

readonly compatibility?: { readonly meeko?: string }

Rango de versiones de Meeko que admite, con la sintaxis de npm (">=1.2", "^1.2.0", ">=1.2 <2", "1.x || 2.x"). Fuera del rango, la carga de la configuración falla.

¿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/modules/define-meeko-module.ts