Dockview
    Preparing search index...

    Interface DockviewModule<THost>

    interface DockviewModule<THost = unknown> {
        dependsOn?: DockviewModule<any>[];
        init?: (host: THost, services: ServiceCollection) => DockviewIDisposable;
        moduleName: string;
        options?: string[];
        services?: Record<string, (host: THost) => unknown>;
    }

    Type Parameters

    • THost = unknown
    Index

    Properties

    dependsOn?: DockviewModule<any>[]
    init?: (host: THost, services: ServiceCollection) => DockviewIDisposable

    Optional post-construct hook called once after the host is fully constructed and all module services are instantiated. Use this to subscribe to host events; the returned disposable runs at host teardown. Components don't need to call into the service from event handlers; the module owns its own reactivity.

    moduleName: string
    options?: string[]

    Top-level option keys that must report this module when it isn't registered: the module's half of the contract with core's OPTION_MODULE_RULES, which core cannot derive because it can't import the modules it might be missing.

    Declared here rather than inferred so a test can hold the two in sync: see enterpriseModuleNames.spec.ts, which fails if an option listed here has no rule (the user would get silence) or a rule names this module for an option not listed here.

    List an option only if it should produce a diagnostic naming this module. Options this module merely reads don't belong here: edgeGroupPeek only tunes autoHideEdgeGroups and is inert alone, and where one opt-in gates two modules in the same package (keyboardNavigation) only the module the message should name declares it: one mistake, one message.

    services?: Record<string, (host: THost) => unknown>