Class BSBEvents<ReferencedConfig>`Abstract`

See

API: BSBEvents

Type Parameters

ReferencedConfig extends BSBReferencePluginConfigType = any

Index

Constructors

constructor

new BSBEvents<ReferencedConfig extends BSBReferencePluginConfigType = any>(
config: BSBEventsConstructor<ReferencedConfig>,
): BSBEvents<ReferencedConfig>
Type Parameters
- ReferencedConfig extends BSBReferencePluginConfigType = any
Parameters
- config: BSBEventsConstructor<ReferencedConfig>
Returns BSBEvents<ReferencedConfig>
Overrides BaseWithObservableAndConfig< ReferencedConfig extends null ? null : BSBReferencePluginConfigDefinition<ReferencedConfig> & BSBReferenceConfigType >.constructor
- Defined in src/base/BSBEvents.ts:58

Properties

`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

`Readonly`config

config: ConfigPropertyTypeSafe<
    ReferencedConfig extends null
        ? null
        : BSBReferencePluginConfigDefinition<ReferencedConfig> & BSBReferenceConfigType,
>

The config of the plugin

Methods

run

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

This method is inherited from the base plugin class but is not used by events plugins. Events plugins are initialized during the init phase and begin processing events immediately. They do not require a separate run phase.

Returns void
void
Remarks
Events plugins establish their event bus connections and listeners during initialization. The event routing is active as soon as init completes. Therefore, this method intentionally performs no operation.
Example
```
// Events plugins do not need to implement run()
// The base class provides this no-op implementation
export class MyEventsPlugin extends BSBEvents<MyConfig> {
  // No run() override needed
}
```
See
- BSBEvents.init for the initialization lifecycle method
- API: BSBEvents#run
Overrides BaseWithObservableAndConfig.run
- Defined in src/base/BSBEvents.ts:88

`Abstract`onBroadcast

onBroadcast(
    trace: Observable,
    pluginName: string,
    event: string,
    listener: (trace: Observable, args: any[]) => Promise<void>,
): Promise<void>
Listens for events that are emitted by other plugins Broadcast events are emitted and received by all plugins
Parameters
- trace: Observable
  The trace object for tracking the operation
- pluginName: string
  The name of the plugin that is being listened to
- event: string
  The event to listen for
- listener: (trace: Observable, args: any[]) => Promise<void>
  The function to call when the event is received
Returns Promise<void>
Promise that resolves when the event listener has been registered
See
- BSB events-default plugin for an example of how to use this function
- Default Events Plugin
- API: BSBEvents#onBroadcast
- Defined in src/base/BSBEvents.ts:104

`Abstract`emitBroadcast

emitBroadcast(
    trace: Observable,
    pluginName: string,
    event: string,
    args: any[],
): Promise<void>
Emits an event that is received by all plugins
Parameters
- trace: Observable
  The trace object for tracking the operation
- pluginName: string
  The name of the plugin that is emitting the event
- event: string
  The event to emit
- args: any[]
  The arguments to pass to the event listener
Returns Promise<void>
Promise that resolves when the event has been emitted
See
- BSB events-default plugin for an example of how to use this function
- Default Events Plugin
- API: BSBEvents#emitBroadcast
- Defined in src/base/BSBEvents.ts:124

`Abstract`onEvent

onEvent(
    trace: Observable,
    pluginName: string,
    event: string,
    listener: (trace: Observable, args: any[]) => Promise<void>,
): Promise<void>
Listens for events that are emitted by other plugins Events are emitted and received by a single plugin
Parameters
- trace: Observable
  The trace object for tracking the operation
- pluginName: string
  The name of the plugin that is being listened to
- event: string
  The event to listen for
- listener: (trace: Observable, args: any[]) => Promise<void>
  The function to call when the event is received
Returns Promise<void>
Promise that resolves when the event listener has been registered
See
- BSB events-default plugin for an example of how to use this function
- Default Events Plugin
- API: BSBEvents#onEvent
- Defined in src/base/BSBEvents.ts:145

`Abstract`emitEvent

emitEvent(
    trace: Observable,
    pluginName: string,
    event: string,
    args: any[],
): Promise<void>
Emits an event that is received by a single plugin
Parameters
- trace: Observable
  The trace object for tracking the operation
- pluginName: string
  The name of the plugin that is emitting the event
- event: string
  The event to emit
- args: any[]
  The arguments to pass to the event listener
Returns Promise<void>
Promise that resolves when the event has been emitted
See
- BSB events-default plugin for an example of how to use this function
- Default Events Plugin
- API: BSBEvents#emitEvent
- Defined in src/base/BSBEvents.ts:165

`Abstract`onReturnableEvent

onReturnableEvent(
    trace: Observable,
    pluginName: string,
    event: string,
    listener: (trace: Observable, args: any[]) => Promise<any>,
): Promise<void>
Listens for events that are emitted by other plugins and return a value Events are emitted and received by a single plugin
Parameters
- trace: Observable
  The trace object for tracking the operation
- pluginName: string
  The name of the plugin that is being listened to
- event: string
  The event to listen for
- listener: (trace: Observable, args: any[]) => Promise<any>
  The function to call when the event is received
Returns Promise<void>
Promise that resolves when the event listener has been registered
See
- BSB events-default plugin for an example of how to use this function
- Default Events Plugin
- API: BSBEvents#onReturnableEvent
- Defined in src/base/BSBEvents.ts:186

`Abstract`emitEventAndReturn

emitEventAndReturn(
    trace: Observable,
    pluginName: string,
    event: string,
    timeoutSeconds: number,
    args: any[],
): Promise<any>
Emits an event that is received by a single plugin and returns a value
Parameters
- trace: Observable
  The trace object for tracking the operation
- pluginName: string
  The name of the plugin that is emitting the event
- event: string
  The event to emit
- timeoutSeconds: number
  The number of seconds to wait for the value to be returned
- args: any[]
  The arguments to pass to the event listener
Returns Promise<any>
Promise that resolves when the event has been emitted and the value has been returned
See
- BSB events-default plugin for an example of how to use this function
- Default Events Plugin
- API: BSBEvents#emitEventAndReturn
- Defined in src/base/BSBEvents.ts:207

`Abstract`receiveStream

receiveStream(
    trace: Observable,
    pluginName: string,
    event: string,
    listener: (
        trace: Observable,
        error: Error | null,
        stream: Readable,
    ) => Promise<void>,
    timeoutSeconds?: number,
): Promise<string>
Sets up a receive stream to receive a stream from another plugin
Parameters
- trace: Observable
  The trace object for tracking the operation
- pluginName: string
  The name of the plugin that is emitting the event
- event: string
  The event to listen for
- listener: (trace: Observable, error: Error | null, stream: Readable) => Promise<void>
  The function to call when the stream is received
- OptionaltimeoutSeconds: number
  The number of seconds to wait for the stream to be received
Returns Promise<string>
Promise that resolves with the stream id that can be used to stream data to the listener
See
- BSB events-default plugin for an example of how to use this function
- Default Events Plugin
- API: BSBEvents#receiveStream
- Defined in src/base/BSBEvents.ts:229

`Abstract`sendStream

sendStream(
    trace: Observable,
    pluginName: string,
    event: string,
    streamId: string,
    stream: Readable,
): Promise<void>
Sets up a send stream to send a stream to another plugin that created a receive stream
Parameters
- trace: Observable
  The trace object for tracking the operation
- pluginName: string
  The name of the plugin that is emitting the event
- event: string
  The event to listen for
- streamId: string
  The id of the stream to send data to
- stream: Readable
  The stream to send data from
Returns Promise<void>
Promise that resolves when the stream has been sent
See
- BSB events-default plugin for an example of how to use this function
- Default Events Plugin
- API: BSBEvents#sendStream
- Defined in src/base/BSBEvents.ts:251

`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 BaseWithObservableAndConfig.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 BaseWithObservableAndConfig.init
- Defined in src/base/base.ts:170

Class BSBEvents<ReferencedConfig>Abstract

See

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BSBEvents<ReferencedConfig>

Properties

ReadonlyappId

See

Readonlymode

Example

Example

Example

See

Readonlycwd

See

ReadonlypackageCwd

See

ReadonlypluginCwd

See

ReadonlypluginName

See

Optional Readonlyregion

See

Readonlyconfig

Methods

run

Returns void

Remarks

Example

See

AbstractonBroadcast

Parameters

Returns Promise<void>

See

AbstractemitBroadcast

Parameters

Returns Promise<void>

See

AbstractonEvent

Parameters

Returns Promise<void>

See

AbstractemitEvent

Parameters

Returns Promise<void>

See

AbstractonReturnableEvent

Parameters

Returns Promise<void>

See

AbstractemitEventAndReturn

Parameters

Returns Promise<any>

See

AbstractreceiveStream

Parameters

Returns Promise<string>

See

AbstractsendStream

Parameters

Returns Promise<void>

See

Optional Abstractdispose

Returns void

Example

Example

See

Optional Abstractinit

Parameters

Returns void | Promise<void>

Remarks

Example

See

Class BSBEvents<ReferencedConfig>`Abstract`

`Readonly`appId

`Readonly`mode

`Readonly`cwd

`Readonly`packageCwd

`Readonly`pluginCwd

`Readonly`pluginName

`Optional` `Readonly`region

`Readonly`config

`Abstract`onBroadcast

`Abstract`emitBroadcast

`Abstract`onEvent

`Abstract`emitEvent

`Abstract`onReturnableEvent

`Abstract`emitEventAndReturn

`Abstract`receiveStream

`Abstract`sendStream

`Optional` `Abstract`dispose

`Optional` `Abstract`init