Kaizen
Browse modulesChatchat/serverchat/server/socket-ioFunctions

Function: createChatGateway()

function createChatGateway(options: ChatGatewayOptions): {
  getStatus: () => {
     connections: number;
     healthy: boolean;
  };
  ready: Promise<void>;
  close: Promise<void>;
};

Defined in: server/chat/socket-io/gateway.ts:116

Mounts a WebSocket-only gateway. The host still owns listening/closing its HTTP server.

Parameters

ParameterType
optionsChatGatewayOptions

Returns

{
  getStatus: () => {
     connections: number;
     healthy: boolean;
  };
  ready: Promise<void>;
  close: Promise<void>;
}

getStatus

getStatus: () => {
  connections: number;
  healthy: boolean;
};

Returns

{
  connections: number;
  healthy: boolean;
}
connections
connections: number = connections.size;
healthy
healthy: boolean;

ready

ready: Promise<void>;

close()

close(): Promise<void>;

Returns

Promise<void>

On this page