GeoLeaf Core API - v3.0.0
    Preparing search index...

    Interface PluginMetadata

    Optional metadata passed to PluginRegistry.register. Every field is optional — callers may register with no metadata at all.

    interface PluginMetadata {
        version?: string | null;
        requires?: string[];
        optional?: string[];
        label?: string;
        healthCheck?: (() => boolean) | null;
    }
    Index

    Properties

    version? requires? optional? label? healthCheck?

    Properties

    version?: string | null

    Semantic version string, or null when unknown.

    requires?: string[]

    Names of plugins that must be loaded for this one to activate.

    optional?: string[]

    Names of plugins that enhance this one when present.

    label?: string

    Human-readable label (defaults to the plugin name).

    healthCheck?: (() => boolean) | null

    Optional runtime health probe used by the console reports.

    Settings

    Member Visibility

    On This Page

    Properties