Skip to main content

event-handlers

MDX event handler registration functionality.

This module provides utilities for registering MDX module event handlers with the event emitter system. It maps event names to callback names and automatically detects and registers matching callbacks from MDX modules.

registerMDXEventHandlers()​

function registerMDXEventHandlers(mdxModule): void;

Defined in: event-handlers.ts:35

Registers MDX module lifecycle event handlers with the event emitter.

Automatically detects and registers any lifecycle hook functions defined in the mdxModule that match the event callback naming convention. Logs registered handlers at debug level.

Note: Format functions (formatMDXBadge, etc.) are NOT registered as events. They are pure transformations handled via the Formatter interface directly.

Parameters​

mdxModule​

unknown

The MDX module that may contain event callback functions

Returns​

void

Example​

const mdxModule = {
  beforeLoadSchemaHook: async (event) => {
    console.log("Loading schema...");
  },
  afterRenderTypeEntitiesHook: async (event) => {
    console.log("Rendered:", event.data.name);
  },
};
registerMDXEventHandlers(mdxModule);