eligius
    Preparing search index...

    Interface IEventMetadata<_TArgs>

    Metadata for an event in the EventBus system.

    This interface describes the structure of event metadata generated from event interface definitions. Metadata is used for documentation, tooling, and runtime validation.

    The tuple type of event arguments

    const seekMetadata: IEventMetadata<[position: number]> = {
      description: 'Event: timeline-seek-request',
      category: 'Timeline',
      args: [
        { name: 'position', type: 'number', description: 'Timeline position to seek to' }
      ]
    };
    interface IEventMetadata<_TArgs extends any[] = any[]> {
        args: { description?: string; name: string; type: string }[];
        category: string;
        description: string;
    }

    Type Parameters

    • _TArgs extends any[] = any[]
    Index

    Properties

    args category description

    Properties

    args: { description?: string; name: string; type: string }[]

    Metadata for each argument in the event's args tuple

    Type Declaration

    • Optionaldescription?: string

      Optional description of the argument from JSDoc

    • name: string

      Name of the argument (from labeled tuple element)

    • type: string

      TypeScript type of the argument as a string (e.g., "number", "string")

    category: string

    Category grouping for the event (e.g., "Timeline", "Language", "Engine")

    description: string

    Human-readable description of the event, typically "Event: {event-name}"

    Settings

    Member Visibility

    On This Page

    Properties