BSB Node.js Type Definitions
    Preparing search index...

    Class SBConfig

    BSB Config Controller

    This class is responsible for managing the configuration in the BSB framework. If you have a specific way of managing configuration, you can extend this class and then use your own class when creating the ServiceBase instance.

    Index

    Constructors

    constructor

    Methods

    getPluginConfig getServicePlugins getEventsPlugins getObservablePlugins getServicePluginDefinition dispose setConfigPlugin init

    Constructors

    • Parameters

      • appId: string
      • mode: DEBUG_MODE
      • cwd: string
      • sbObservable: SBObservable
      • sbPlugins: SBPlugins
      • createObservable: (
            trace: DTrace,
            pluginName: string,
            attributes?: Record<string, string | number | boolean>,
        ) => Observable

      Returns SBConfig

    Methods

    • Parameters

      • trace: DTrace
      • pluginType: PluginType
      • name: string

      Returns Promise<object | null>

    • Parameters

      • trace: DTrace

      Returns Promise<Record<string, PluginDefinition>>

    • Parameters

      • trace: DTrace

      Returns Promise<Record<string, EventsConfig>>

    • Parameters

      • trace: DTrace

      Returns Promise<Record<string, ObservableConfig>>

    • Parameters

      • trace: DTrace
      • pluginName: string

      Returns Promise<{ name: string; enabled: boolean }>

    • Dispose config subsystem

      Returns void

      API: SBConfig.dispose

    • Set the active config plugin implementation

      Parameters

      • reference: LoadedPlugin<"config">

      Returns Promise<BSBConfig<any>>

      API: SBConfig.setConfigPlugin

    • Initialize config plugin (default or loaded)

      Returns Promise<void>

      API: SBConfig.init

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods