ServerAndEventStreamsHost

Kind: Interface

Source: packages/websockets/interfaces/server-and-event-streams-host.interface.ts

Part of: Websockets

ServerAndEventStreamsHost<T> defines a shared host for a server instance and its lifecycle event streams. It exposes the server object along with RxJS subjects for initialization, client connections, and disconnections, allowing websocket integrations to publish and observe server events consistently.

Properties

Diagram

mermaid
graph LR
  Host[ServerAndEventStreamsHost<T>]
  Server[T server]
  Init[ReplaySubject<T><br/>init]
  Connection[Subject<any><br/>connection]
  Disconnect[Subject<any><br/>disconnect]

  Host --> Server
  Host --> Init
  Host --> Connection
  Host --> Disconnect

  Init --> Consumers[Server lifecycle consumers]
  Connection --> Consumers
  Disconnect --> Consumers

Usage

ts
import { ReplaySubject, Subject } from 'rxjs';
import type { ServerAndEventStreamsHost } from './server-and-event-streams-host.interface';

interface WebSocketServer {
  close(): void;
}

const websocketServer: WebSocketServer = {
  close() {
    console.log('Server closed');
  },
};

const host: ServerAndEventStreamsHost<WebSocketServer> = {
  server: websocketServer,
  init: new ReplaySubject<WebSocketServer>(1),
  connection: new Subject<any>(),
  disconnect: new Subject<any>(),
};

// Notify subscribers that the server is ready.
host.init.next(host.server);

// Publish connection lifecycle events.
host.connection.subscribe((client) => {
  console.log('Client connected:', client.id);
});

host.disconnect.subscribe((client) => {
  console.log('Client disconnected:', client.id);
});

host.connection.next({ id: 'client-1' });
host.disconnect.next({ id: 'client-1' });

AI Coding Instructions

• Use init as a ReplaySubject<T> so late subscribers can receive the initialized server instance.
• Emit the server instance through init.next(server) only after the server is fully configured and ready to accept connections.
• Publish connection and disconnection payloads through the corresponding subjects; keep payload shapes consistent across adapters.
• Prefer strongly typed connection payloads over any when extending or consuming this interface.
• Clean up subject subscriptions and complete streams during server shutdown when the owning lifecycle supports it.

How it works

ServerAndEventStreamsHost<T>

ServerAndEventStreamsHost<T> is a public exported TypeScript interface for a websocket server value and three RxJS event streams. Its generic server type defaults to any. [server-and-event-streams-host.interface.ts:3-10]