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

    Represents the GeoLeaf configuration subsystem: helpers, validators, renderers, data normalizers, and the Config singleton.

    Kept by Lot 6 (unlike security/api) for its teardown: four modules depend on it, and its destroy() carries real work — even though its init() no longer does.

    Implements

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    id: "config" = ...

    Unique module identifier within the GeoLeaf instance.

    The registry enforces uniqueness — registering two modules with the same id throws a GeoLeafError. Use lowercase kebab-case.

    `'geojson'`, `'route'`, `'legend'`, `'layer-manager'`
    
    dependencies: readonly [] = ...

    IDs of modules that must be fully initialised before this module's init() is called.

    The registry resolves a topological order from these declarations. An empty array means this module has no dependencies.

    Use as const in implementing classes for best type inference:

    readonly dependencies = ['poi', 'ui'] as const;
    

    Methods

    • Initialises the module.

      Called by the registry after all declared dependencies are ready. Guaranteed postconditions at call time:

      • adapter.isReady() returns true
      • config.isLoaded() returns true
      • All modules listed in dependencies have completed their init()

      Returning void (synchronous) is allowed for modules that do not perform async work. The registry handles both with Promise.resolve().

      Returns void

    • Tears down the module and releases all resources.

      Must remove every event listener, DOM node, and layer reference created during init(). After destroy(), the module must be safe to garbage collect.

      Called by the registry in reverse dependency order (dependants are destroyed before their dependencies).

      Returns void