MeekoModuleDefinition
interfaz Desde 1.2.0
Definición que recibe defineMeekoModule.
ts
import type { MeekoModuleDefinition } from "@meekojs/meeko/framework";Código fuente src/modules/define-meeko-module.ts:394
Declaración #
ts
interface MeekoModuleDefinition<Options extends object> {
readonly meta: MeekoModuleMeta
readonly defaults?: Partial<Options>
setup(options: Options, meeko: MeekoModuleContext): void | Promise<void>
}Parámetros de tipo #
-
Optionsextends object Opciones del módulo.
Ejemplo #
ts
import type { MeekoModuleDefinition } from "@meekojs/meeko/framework";
const definition: MeekoModuleDefinition<{ greeting: string }> = {
meta: { name: "hello", configKey: "hello" },
defaults: { greeting: "Hola" },
setup(options, meeko) { meeko.warn(options.greeting); },
};Miembros #
defaults
#
readonly defaults?: Partial<Options>Valores por defecto de las opciones; config[configKey] (y las de [module, options], obsoleto) los sustituyen.
setup
#
setup(options: Options, meeko: MeekoModuleContext): void | Promise<void>Configura el proyecto en Node con las opciones combinadas. Puede ser asíncrona.