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

    Type Alias StartupProgress

    type StartupProgress = {
        activated: number;
        event?: string;
        humanizedName?: string;
        module?: string;
        pluginName?: string;
        pluginSlug?: string;
        progress: number;
        total: number;
    }
    Index

    Properties

    activated: number

    Number of modules that have been activated.

    event?: string

    Raw activation event key (e.g. org.dxos.app-framework.event.startup). Set on event-level transitions, and on module-level transitions where it carries the parent activation event that first triggered the module's load (plumbed through _loadCapabilitiesForModules → _loadModule). Consumers can use this either as the primary id (when module is absent) or as an extra "context" field alongside module.

    humanizedName?: string

    Pre-humanized label for the currently surfaced transition (module label if module is set, otherwise the event label), supplied for consumers that want a sensible default. Hosts that prefer to render their own label can read the raw event/module fields and ignore this — the framework leaves the policy choice (which transitions to surface, how to format them, whether to drop sub-modules entirely) to the host's Placeholder.

    module?: string

    Raw module id (e.g. org.dxos.plugin.observability.module.ReactSurface) when the in-flight activation is module-level. When present, event may also be set, identifying the parent activation that triggered this module's load.

    pluginName?: string

    Humanized label of the plugin owning module (e.g. "Markdown"), absent on event-level transitions. Lets a host collapse a plugin's many module activations into a single status line without re-parsing module ids.

    pluginSlug?: string

    Slug of the plugin owning module (e.g. markdown) — the id the boot loader's row keys on.

    progress: number

    Fractional progress (0-1).

    total: number

    Total number of modules registered.