ModuleDefinition interface

Home > @rimitive/core > ModuleDefinition

ModuleDefinition interface

Input type for defineModule - same as Module but without status and with optional dependencies.

The TModules type parameter captures the dependencies tuple, allowing TypeScript to infer the correct types for the create function’s deps parameter.

Signature:

export interface ModuleDefinition<TName extends string, TImpl, TModules extends readonly AnyModule[] = readonly []>

Properties

Property	Modifiers	Type	Description
dependencies?		TModules	(Optional) Modules this module depends on (resolved by compose)
name		TName	Unique name - becomes the property name on the composed context

Methods

Method	Description
create(deps)	Create the implementation with resolved dependencies
destroy(ctx)?	(Optional) Optional: called when context is disposed
init(ctx)?	(Optional) Optional: called when module is added to context
instrument(impl, instrumentation, ctx)?	(Optional) Optional: wrap impl for debugging/profiling when instrumentation is enabled