@dxos/app-framework - v0.8.3
    Preparing search index...

    Interface PluginModule

    A unit of containment of modular functionality that can be provided to an application. Activation of a module is async allowing for code to split and loaded lazily.

    interface PluginModule {
        "[PluginModuleTypeId]": typeof Plugin.PluginModuleTypeId;
        activate: (
            props?: any,
        ) => Effect<ModuleReturn, Error, Capability.Service | Plugin.Service>;
        activatesAfter?: ActivationEvent.ActivationEvent[];
        activatesBefore?: ActivationEvent.ActivationEvent[];
        activatesOn: Events;
        id: string;
    }
    Index

    Properties

    [PluginModuleTypeId] activate activatesAfter? activatesBefore? activatesOn id

    Properties

    "[PluginModuleTypeId]": typeof Plugin.PluginModuleTypeId
    activate: (
        props?: any,
    ) => Effect<ModuleReturn, Error, Capability.Service | Plugin.Service>

    Called when the module is activated. CapabilityManager is accessed via the Effect layer system (Capability.Service). PluginManager is accessed via Plugin.Service.

    Type declaration

    activatesAfter?: ActivationEvent.ActivationEvent[]

    Events which this plugin triggers upon activation.

    activatesBefore?: ActivationEvent.ActivationEvent[]

    Events which the plugin depends on being activated. Plugin is marked as needing reset a plugin activated by a dependent event is removed. Events are automatically activated before activation of the plugin.

    activatesOn: Events

    Events for which the module will be activated.

    id: string

    Unique id of the module.

    Settings

    Member Visibility

    On This Page

    Properties