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

    Interface Module<Options>

    A module body carrying its activation spec as erased runtime values. The spec types are enforced where the body is authored (lazyModule / inlineModule) and deliberately absent from this type, so exporting a module never leaks foreign capability types into declaration emit (TS2883). Runtime manager validation is authoritative.

    interface Module<Options = void> {
        "[AdapterTag]"?: LoaderAdapter;
        "[LoaderTag]"?: () => Promise<unknown>;
        activatesOn?: Events;
        environments?: readonly string[];
        load?: () => Promise<unknown>;
        mapsProps?: boolean;
        provides: readonly AnyTag[];
        requires?: readonly AnyTag[];
        (options: Options): Effect<any, Error, any>;
    }

    Type Parameters

    • Options = void
    Index

    Properties

    [AdapterTag]? [LoaderTag]? activatesOn? environments? load? mapsProps? provides requires?

    Properties

    "[AdapterTag]"?: LoaderAdapter
    "[LoaderTag]"?: () => Promise<unknown>
    activatesOn?: Events
    environments?: readonly string[]
    load?: () => Promise<unknown>

    Imports a lazy module's body without activating it; absent on inline modules.

    mapsProps?: boolean

    Set when a props mapper adapts plugin options for the body, which a manifest cannot carry.

    provides: readonly AnyTag[]
    requires?: readonly AnyTag[]

    Settings

    Member Visibility

    On This Page

    Properties