Skip to content
Meeko
Type to search the guides and the API reference. Open it from any page with / or Ctrl K; move with the arrow keys and open a result with Enter.
Get started

Contents

On this page

Not translated yet

This page has not been translated into English yet, so it is shown in Spanish.

MeekoModuleMeta

interfaz Since 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";

Source code src/modules/define-meeko-module.ts:20

Declaración #

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

Example #

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.

Was this page helpful?

Add a comment

It is sent when you choose “Yes” or “No”. Only the page, your answer and the comment are stored: no cookies and no personal data.

0 of 2000 characters

Edit on GitHub: packages/meeko/src/modules/define-meeko-module.ts