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

    Interface IIntrospectionAPI

    Read-only introspection surface exposed as GeoLeaf.Introspection.

    Consumed by studio and form-builder plugins (P4) to enumerate active modules and read their declared schemas without coupling to the registry internals.

    const modules = GeoLeaf.Introspection.getActiveModules();
    for (const mod of modules) {
        const schema = GeoLeaf.Introspection.getModuleSchema(mod.id);
        if (schema) buildFormFor(schema);
    }
    interface IIntrospectionAPI {
        getModuleSchema(id: string): IModuleSchema | null;
        getActiveModules(): readonly IModuleInfo[];
        getCapabilitySchema(id: string): ICapabilitySchema | null;
        getAllCapabilities(): readonly ICapabilitySchema[];
        getCapabilityStatus(): readonly ICapabilityStatus[];
    }
    Index

    Methods

    getModuleSchema getActiveModules getCapabilitySchema getAllCapabilities getCapabilityStatus

    Methods

    • Returns a read-only snapshot of all registered modules.

      The order matches the insertion order of ModuleRegistry.register(). After registry.init(), this includes both built-in and lazily registered plugin modules.

      Returns readonly IModuleInfo[]

    • Returns the introspectable schema of a registered capability, or null if no capability with the given id has been declared.

      The returned schema never contains the loader field.

      Parameters

      • id: string

        Capability id (e.g. 'labels', 'route', 'cluster').

      Returns ICapabilitySchema | null

    • Returns, for every declared capability, what switches it on and why.

      One question, one answer — distinct from both neighbours:

      • getAllCapabilities() returns what is declared (the schema);
      • getActiveModules() returns what is running (initialised modules);
      • this one returns the config verdict: embarked? enabled? through which gate?

      enabled is re-read on each call against GeoLeaf.Config, hence against the profile-merged config as soon as the profile is loaded. Before boot() no config is loaded and every gate answers its enableWhenAbsent — which is the exact answer to "with what is configured right now", not a fallback value.

      Order matches registration order.

      Returns readonly ICapabilityStatus[]

    Settings

    Member Visibility

    On This Page

    Methods