Class BSBServiceClient<Service>`Abstract`

See

API: BSBServiceClient

Type Parameters

Service extends BSBService<any, any> = BSBService<any, BSBEventSchemas>

Hierarchy (View Summary)

BSBServiceClient
- ServiceClient

Index

Constructors

Properties

events pluginName initBeforePlugins? initAfterPlugins? runBeforePlugins? runAfterPlugins?

Methods

dispose? init? run?

Constructors

constructor

new BSBServiceClient<
Service extends BSBService<any, any> = BSBService<any, BSBEventSchemas>,
>(
context: BSBService,
): BSBServiceClient<Service>
Type Parameters
- Service extends BSBService<any, any> = BSBService<any, BSBEventSchemas>
Parameters
- context: BSBService
Returns BSBServiceClient<Service>
- Defined in src/base/BSBServiceClient.ts:59

Properties

`Readonly`events

events: PluginEvents<ServiceClientEventSchemas<BSBEventSchemas>>

`Abstract` `Readonly`pluginName

pluginName: string

`Optional` `Abstract` `Readonly`initBeforePlugins

initBeforePlugins?: string[]

`Optional` `Abstract` `Readonly`initAfterPlugins

initAfterPlugins?: string[]

`Optional` `Abstract` `Readonly`runBeforePlugins

runBeforePlugins?: string[]

`Optional` `Abstract` `Readonly`runAfterPlugins

runAfterPlugins?: string[]

Methods

`Optional` `Abstract`dispose

dispose?(): void
Returns void
- Defined in src/base/BSBServiceClient.ts:69

`Optional` `Abstract`init

init?(obs: Observable): Promise<void>
Init Optional function to be called when the client is being initialized
Parameters
- obs: Observable
  Observable context with logging, metrics, and trace information
Returns Promise<void>
Remarks
v9 BREAKING CHANGE: Now requires Observable instead of DTrace.
- Defined in src/base/BSBServiceClient.ts:80

`Optional` `Abstract`run

run?(obs: Observable): Promise<void>
Run Optional function to be called when the client is being run
Parameters
- obs: Observable
  Observable context with logging, metrics, and trace information
Returns Promise<void>
Remarks
v9 BREAKING CHANGE: Now requires Observable instead of DTrace.
- Defined in src/base/BSBServiceClient.ts:91