Class PluginEvents<TEventSchemas, TClientApi>

Schema-first plugin events handler with automatic validation and object parameters.

See

API: PluginEvents

Type Parameters

TEventSchemas extends BSBEventSchemas = BSBEventSchemas
TClientApi extends boolean = false

Index

Constructors

constructor

Methods

onBroadcast emitBroadcast onEvent emitEvent onReturnableEvent emitEventAndReturn receiveStream sendStream

Constructors

constructor

new PluginEvents<
    TEventSchemas extends BSBEventSchemas = BSBEventSchemas,
    TClientApi extends boolean = false,
>(
    mode: DEBUG_MODE,
    events: SBEvents,
    context:
        | BSBService<any, BSBEventSchemas>
        | BSBServiceClient<BSBService<any, BSBEventSchemas>>,
    eventSchemas: TEventSchemas,
    observableBackend?: IPluginObservable,
): PluginEvents<TEventSchemas, TClientApi>
Type Parameters
- TEventSchemas extends BSBEventSchemas = BSBEventSchemas
- TClientApi extends boolean = false
Parameters
- mode: DEBUG_MODE
- events: SBEvents
- context:
  | BSBService<any, BSBEventSchemas>
  | BSBServiceClient<BSBService<any, BSBEventSchemas>>
- eventSchemas: TEventSchemas
- OptionalobservableBackend: IPluginObservable
Returns PluginEvents<TEventSchemas, TClientApi>
- Defined in src/base/PluginEvents.ts:62

Methods

onBroadcast

onBroadcast<
    TBroadcast extends BroadcastEventSchemas,
    K extends string | number | symbol,
>(
    eventName: K,
    obs: Observable,
    listener: (
        handlerObs: Observable,
        input: EventInputType<TBroadcast[K]>,
    ) => Promise<void>,
): Promise<void>
Listen for broadcast events emitted by other plugins with full type safety.
Type Parameters
- TBroadcast extends BroadcastEventSchemas
- K extends string | number | symbol
Parameters
- eventName: K
  Name of the event to listen for (strongly typed)
- obs: Observable
  Observable context (v9 BREAKING: Observable only, no longer accepts DTrace)
- listener: (handlerObs: Observable, input: EventInputType<TBroadcast[K]>) => Promise<void>
  Function to call when event is received (receives Observable and validated input object)
Returns Promise<void>
See
API: PluginEvents#onBroadcast
- Defined in src/base/PluginEvents.ts:106

emitBroadcast

emitBroadcast<
    TBroadcast extends BroadcastEventSchemas,
    K extends string | number | symbol,
>(
    eventName: K,
    obs: Observable,
    input: EventInputType<TBroadcast[K]>,
): Promise<void>
Emit broadcast events to all listening plugins with full type safety.
Type Parameters
- TBroadcast extends BroadcastEventSchemas
- K extends string | number | symbol
Parameters
- eventName: K
  Name of the event to emit (strongly typed)
- obs: Observable
  Observable context (v9 BREAKING: Observable only, no longer accepts DTrace)
- input: EventInputType<TBroadcast[K]>
  Event input object (will be validated against schema)
Returns Promise<void>
See
API: PluginEvents#emitBroadcast
- Defined in src/base/PluginEvents.ts:150

onEvent

onEvent<
    TEvents extends FireAndForgetEventSchemas,
    K extends string | number | symbol,
>(
    eventName: K,
    obs: Observable,
    listener: (
        handlerObs: Observable,
        input: EventInputType<TEvents[K]>,
    ) => Promise<void>,
): Promise<void>
Listen for fire-and-forget events from other plugins with full type safety.
Type Parameters
- TEvents extends FireAndForgetEventSchemas
- K extends string | number | symbol
Parameters
- eventName: K
  Name of the event to listen for (strongly typed)
- obs: Observable
  Observable context (v9 BREAKING: Observable only, no longer accepts DTrace)
- listener: (handlerObs: Observable, input: EventInputType<TEvents[K]>) => Promise<void>
  Function to call when event is received (receives Observable and validated input object)
Returns Promise<void>
See
API: PluginEvents#onEvent
- Defined in src/base/PluginEvents.ts:186

emitEvent

emitEvent<
    TEvents extends FireAndForgetEventSchemas,
    K extends string | number | symbol,
>(
    eventName: K,
    obs: Observable,
    input: EventInputType<TEvents[K]>,
): Promise<void>
Emit fire-and-forget events to other plugins with full type safety.
Type Parameters
- TEvents extends FireAndForgetEventSchemas
- K extends string | number | symbol
Parameters
- eventName: K
  Name of the event to emit (strongly typed)
- obs: Observable
  Observable context (v9 BREAKING: Observable only, no longer accepts DTrace)
- input: EventInputType<TEvents[K]>
  Event input object (will be validated against schema)
Returns Promise<void>
See
API: PluginEvents#emitEvent
- Defined in src/base/PluginEvents.ts:230

onReturnableEvent

onReturnableEvent<
    TEvents extends ReturnableEventSchemas,
    K extends string | number | symbol,
>(
    eventName: K,
    obs: Observable,
    listener: (
        handlerObs: Observable,
        input: EventInputType<TEvents[K]>,
    ) => Promise<EventOutputType<TEvents[K]>>,
): Promise<void>
Listen for returnable events from other plugins with full type safety.
Type Parameters
- TEvents extends ReturnableEventSchemas
- K extends string | number | symbol
Parameters
- eventName: K
  Name of the event to listen for (strongly typed)
- obs: Observable
  Observable context (v9 BREAKING: Observable only, no longer accepts DTrace)
- listener: (
  handlerObs: Observable,
  input: EventInputType<TEvents[K]>,
  ) => Promise<EventOutputType<TEvents[K]>>
  Function to call when event is received (receives Observable), must return a value
Returns Promise<void>
See
API: PluginEvents#onReturnableEvent
- Defined in src/base/PluginEvents.ts:266

emitEventAndReturn

emitEventAndReturn<
    TEvents extends ReturnableEventSchemas,
    K extends string | number | symbol,
>(
    eventName: K,
    obs: Observable,
    input: EventInputType<TEvents[K]>,
    timeoutSeconds?: number,
): Promise<EventOutputType<TEvents[K]>>
Emit returnable events and wait for response with full type safety.
Type Parameters
- TEvents extends ReturnableEventSchemas
- K extends string | number | symbol
Parameters
- eventName: K
  Name of the event to emit (strongly typed)
- obs: Observable
  Observable context (v9 BREAKING: Observable only, no longer accepts DTrace)
- input: EventInputType<TEvents[K]>
  Event input object (will be validated against schema)
- timeoutSeconds: number = 5
  Optional timeout in seconds (default: 5)
Returns Promise<EventOutputType<TEvents[K]>>
See
API: PluginEvents#emitEventAndReturn
- Defined in src/base/PluginEvents.ts:325

receiveStream

receiveStream(
    trace: DTrace,
    eventName: string,
    listener: (error: Error | null, stream: Readable) => Promise<void>,
    timeoutSeconds?: number,
): Promise<string>
Get stream ID for receiving streamed data from another plugin.
Parameters
- trace: DTrace
  Trace for logging context
- eventName: string
  Name of the stream event
- listener: (error: Error | null, stream: Readable) => Promise<void>
  Function called when stream is received
- OptionaltimeoutSeconds: number
  Optional timeout in seconds
Returns Promise<string>
See
API: PluginEvents#receiveStream
- Defined in src/base/PluginEvents.ts:375

sendStream

sendStream(
    trace: DTrace,
    eventName: string,
    streamId: string,
    stream: Readable,
): Promise<void>
Send stream data to another plugin.
Parameters
- trace: DTrace
  Trace for logging context
- eventName: string
  Name of the stream event
- streamId: string
  ID of the stream to send to
- stream: Readable
  The readable stream to send
Returns Promise<void>
See
API: PluginEvents#sendStream
- Defined in src/base/PluginEvents.ts:399

Class PluginEvents<TEventSchemas, TClientApi>

See

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PluginEvents<TEventSchemas, TClientApi>

Methods

onBroadcast

Type Parameters

Parameters

Returns Promise<void>

See

emitBroadcast

Type Parameters

Parameters

Returns Promise<void>

See

onEvent

Type Parameters

Parameters

Returns Promise<void>

See

emitEvent

Type Parameters

Parameters

Returns Promise<void>

See

onReturnableEvent

Type Parameters

Parameters

Returns Promise<void>

See

emitEventAndReturn

Type Parameters

Parameters

Returns Promise<EventOutputType<TEvents[K]>>

See

receiveStream

Parameters

Returns Promise<string>

See

sendStream

Parameters

Returns Promise<void>

See

Settings

On This Page