Class Bagman

Hierarchy

Bagman

Index

Constructors

Properties

config securityCtx socket

Methods

authorize close listen subscribe

Constructors

constructor

new Bagman(config: BagmanConfig): Bagman
Creates a new Bagman instance.
Parameters
- config: BagmanConfig
Returns Bagman
- Defined in bagman.ts:33

Properties

`Private` config

config: BagmanConfig

Configuration for this Bagman Client

`Private` securityCtx

securityCtx: SecurityContext

The Holder for Authentication

`Private` socket

socket: ClientSocket

The socket connection.

Methods

authorize

authorize(): Promise<void>
Returns Promise<void>
- Defined in bagman.ts:51

close

close(): void
Returns void
- Defined in bagman.ts:93

listen

listen<T>(event: GlobalEvent, cb: ((...args: T) => void | Promise<void>)): void
Listens to a specific global event.

Throws
When an invalid event is provided.
Type Parameters
- T extends any[]
  
  The type of the arguments to be passed to the callback.
Parameters
- event: GlobalEvent
  
  The global event to listen to.
- cb: ((...args: T) => void | Promise<void>)
  
  The callback to be called when the event is emitted.
  - - (...args: T): void | Promise<void>
    - Parameters
      
      Rest ...args: T
      
      Returns void | Promise<void>
Returns void
- Defined in bagman.ts:88

subscribe

subscribe(channel: string): Promise<Channel>
Subscribes to a channel.

Returns
A promise that resolves with a Channel instance.
Parameters
- channel: string
  
  The channel to subscribe to.
Returns Promise<Channel>
- Defined in bagman.ts:70

Generated using TypeDoc