Class RealtimeManager

Multi-connection realtime registry.

Resolves a broadcaster by name (realtimeManager.connection('redis')) through the agnostic Broadcaster contract. A process-wide default instance lets the client and helpers reach it without wiring.

Index

Constructors

Methods

connection has register registerFactory setDefaultConnection create getInstance setInstance

Constructors

constructor

new RealtimeManager(defaultConnection?: string): RealtimeManager
Parameters
- defaultConnection: string = 'memory'
  The default connection name.
Returns RealtimeManager

Methods

connection

connection(name?: string): Broadcaster
Resolve a broadcaster by name (defaults to the default connection).
Parameters
- Optionalname: string
  The connection name.
Returns Broadcaster
The resolved Broadcaster.

Throws
When no connection/factory is registered under the name.

has

has(name: string): boolean
Whether a connection (instance or factory) is registered under the name.
Parameters
- name: string
  The connection name.
Returns boolean
True if registered.

register

register(name: string, broadcaster: Broadcaster): this
Register a ready-made broadcaster instance.
Parameters
- name: string
  The connection name.
- broadcaster: Broadcaster
  The broadcaster.
Returns this
This manager for chaining.

registerFactory

registerFactory(name: string, factory: BroadcasterThunk): this
Register a lazy factory for a connection (built on first access).
Parameters
- name: string
  The connection name.
- factory: BroadcasterThunk
  The broadcaster factory.
Returns this
This manager for chaining.

setDefaultConnection

setDefaultConnection(name: string): this
Set the default connection name.
Parameters
- name: string
  The connection name.
Returns this
This manager for chaining.

`Static`create

create(defaultConnection?: string): RealtimeManager
Create a RealtimeManager.
Parameters
- defaultConnection: string = 'memory'
  The default connection name.
Returns RealtimeManager
A new manager.

`Static`getInstance

getInstance(): RealtimeManager

The process-wide default manager, if the realtime module has been booted.

Returns RealtimeManager
The manager, or undefined.

`Static`setInstance

setInstance(manager?: RealtimeManager): void
Register (or replace) the process-wide default manager.
Parameters
- Optionalmanager: RealtimeManager
  The manager (or undefined to clear).
Returns void