Class BSBConfig<ReferencedConfig>`Abstract`

Template: T

The type of config for the plugin Abstract class representing the configuration for the Better Service Base.

See

API: BSBConfig

Type Parameters

ReferencedConfig extends BSBReferencePluginConfigType = any

Index

Constructors

constructor

new BSBConfig<ReferencedConfig extends BSBReferencePluginConfigType = any>(
config: BSBConfigConstructor<ReferencedConfig>,
): BSBConfig<ReferencedConfig>
Type Parameters
- ReferencedConfig extends BSBReferencePluginConfigType = any
Parameters
- config: BSBConfigConstructor<ReferencedConfig>
Returns BSBConfig<ReferencedConfig>
Overrides BaseWithObservable.constructor
- Defined in src/base/BSBConfig.ts:77

Properties

`Readonly`config

config: BSBConfigPropertyTypeSafe<BSBConfigResolvedConfig<ReferencedConfig>>

`Readonly`appId

appId: string = "tbd"

The unique app id of the app that is running

See

API: MainBase.appId

`Readonly`mode

mode: DEBUG_MODE = "development"

The mode the app is running in

Example

production (production mode - no debug)

Example

production-debug (production mode - debug)

Example

development (development mode - debug)

See

API: MainBase.mode

`Readonly`cwd

cwd: string

The current working directory of the app

See

API: MainBase.cwd

`Readonly`packageCwd

packageCwd: string

The current working directory of the plugin

See

API: MainBase.packageCwd

`Readonly`pluginCwd

pluginCwd: string

The current working directory of the service

See

API: MainBase.pluginCwd

`Readonly`pluginName

pluginName: string

The name of the plugin This is also the mapped name, or the name defined in the config rather than it's original defined name

See

API: MainBase.pluginName

`Optional` `Readonly`region

region?: string

The deployment region for resource context

See

API: MainBase.region

Methods

run

run(): void
Run lifecycle method for configuration plugins.

This method is inherited from the base plugin class but is not used by configuration plugins. Configuration plugins are initialized during the init phase and provide configuration data to other plugins. They do not require a separate run phase.

Returns void
void
Remarks
Configuration plugins are typically disposed after all other plugins have been initialized to free up memory, as configuration data is cached by individual plugins. Therefore, this method intentionally performs no operation.
Example
```
// Configuration plugins do not need to implement run()
// The base class provides this no-op implementation
export class MyConfigPlugin extends BSBConfig {
  // No run() override needed
}
```
See
- BSBConfig.init for the initialization lifecycle method
- API: BSBConfig#run
Overrides BaseWithObservable.run
- Defined in src/base/BSBConfig.ts:108

`Abstract`getObservablePlugins

getObservablePlugins(obs: Observable): Promise<Record<string, ObservableConfig>>
Returns the observable plugins configuration (unified logging, metrics, tracing).
Parameters
- obs: Observable
Returns Promise<Record<string, ObservableConfig>>
Promise resolving to an object containing the observable configuration for each plugin.

See
API: BSBConfig#getObservablePlugins
- Defined in src/base/BSBConfig.ts:115

`Abstract`getEventsPlugins

getEventsPlugins(obs: Observable): Promise<Record<string, EventsConfig>>
Returns the events plugins configuration.
Parameters
- obs: Observable
Returns Promise<Record<string, EventsConfig>>
Promise resolving to an object containing the events configuration for each plugin.

See
API: BSBConfig#getEventsPlugins
- Defined in src/base/BSBConfig.ts:122

`Abstract`getServicePlugins

getServicePlugins(obs: Observable): Promise<Record<string, PluginDefinition>>
Returns the service plugins configuration.
Parameters
- obs: Observable
Returns Promise<Record<string, PluginDefinition>>
Promise resolving to an object containing the configuration for each plugin.

See
API: BSBConfig#getServicePlugins
- Defined in src/base/BSBConfig.ts:129

`Abstract`getServicePluginDefinition

getServicePluginDefinition(
obs: Observable,
pluginName: string,
): Promise<{ name: string; enabled: boolean }>
Returns a mapped plugin name and whether the plugin is enabled or not
Parameters
- obs: Observable
- pluginName: string
Returns Promise<{ name: string; enabled: boolean }>
string of the plugin name and if it is enabled or not

See
API: BSBConfig#getServicePluginDefinition
- Defined in src/base/BSBConfig.ts:136

`Abstract`getPluginConfig

getPluginConfig(
    obs: Observable,
    pluginType: PluginType,
    plugin: string,
): Promise<object | null>
Returns the configuration for a specific plugin.
Parameters
- obs: Observable
- pluginType: PluginType
- plugin: string
  The name of the plugin to retrieve the configuration for.
Returns Promise<object | null>
Promise resolving to the configuration object for the specified plugin, or null if the plugin is not found.

See
API: BSBConfig#getPluginConfig
- Defined in src/base/BSBConfig.ts:148

`Optional` `Abstract`dispose

dispose?(): void
Dispose Optional function to be called when the plugin is being disposed

Returns void
Example
```
dispose?(): void; //to not use it
```
Example
```
dispose() { your code here };
```
See
API: Base.dispose
Inherited from BaseWithObservable.dispose
- Defined in src/base/base.ts:146

`Optional` `Abstract`init

init?(obs: Observable): void | Promise<void>
Init Optional function to be called when the plugin is being initialized Can be sync or async
Parameters
- obs: Observable
  Observable context with logging, metrics, and trace information
Returns void | Promise<void>
Remarks
v9 BREAKING CHANGE: Now requires Observable instead of DTrace. Observable provides unified access to logging, metrics, and tracing with automatic context propagation.
Example
```
async init(obs: Observable) {
  obs.log.info("Initializing plugin");
  // Set attributes for all child operations
  const withVersion = obs.setAttribute("plugin.version", "1.0.0");
}
```
See
API: Base.init
Inherited from BaseWithObservable.init
- Defined in src/base/base.ts:170

Class BSBConfig<ReferencedConfig>Abstract

Template: T

See

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BSBConfig<ReferencedConfig>

Properties

Readonlyconfig

ReadonlyappId

See

Readonlymode

Example

Example

Example

See

Readonlycwd

See

ReadonlypackageCwd

See

ReadonlypluginCwd

See

ReadonlypluginName

See

Optional Readonlyregion

See

Methods

run

Returns void

Remarks

Example

See

AbstractgetObservablePlugins

Parameters

Returns Promise<Record<string, ObservableConfig>>

See

AbstractgetEventsPlugins

Parameters

Returns Promise<Record<string, EventsConfig>>

See

AbstractgetServicePlugins

Parameters

Returns Promise<Record<string, PluginDefinition>>

See

AbstractgetServicePluginDefinition

Parameters

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

See

AbstractgetPluginConfig

Parameters

Returns Promise<object | null>

See

Optional Abstractdispose

Returns void

Example

Example

See

Optional Abstractinit

Parameters

Returns void | Promise<void>

Remarks

Example

See

Settings

On This Page

Class BSBConfig<ReferencedConfig>`Abstract`

`Readonly`config

`Readonly`appId

`Readonly`mode

`Readonly`cwd

`Readonly`packageCwd

`Readonly`pluginCwd

`Readonly`pluginName

`Optional` `Readonly`region

`Abstract`getObservablePlugins

`Abstract`getEventsPlugins

`Abstract`getServicePlugins

`Abstract`getServicePluginDefinition

`Abstract`getPluginConfig

`Optional` `Abstract`dispose

`Optional` `Abstract`init