Interface ImmutablePlugin<C>

Interface representing an immutable plugin in the plugin system. Plugins expose typed read-only entities to the host and other plugins.

interface ImmutablePlugin<
    C extends ImmutableEntitiesRecord = ImmutableEntitiesRecord,
> {
    entities: Readonly<{ [K in keyof C]-?: Exclude<C[K], undefined> }>;
    name: string;
}

C extends ImmutableEntitiesRecord = ImmutableEntitiesRecord
The entities configuration type, where each entity type must be a record

Properties

entities: Readonly<{ [K in keyof C]-?: Exclude<C[K], undefined> }>

The entities exposed by this plugin. All entities are immutable and cannot be modified at runtime.

name: string

Unique identifier for this plugin.