node-jet
Version:
Jet Realtime Message Bus for the Web. Daemon and Peer implementation.
26 lines (25 loc) • 819 B
TypeScript
import { EventEmitter } from './index.js';
import { WebSocketServer as WsServer } from 'ws';
import type { Server as HTTPServer } from 'http';
export interface WebServerConfig {
url?: string;
wsPort?: number;
wsPath?: string;
server?: HTTPServer;
wsPingInterval?: number;
}
/**
* Class implementation of a WS server. This implementation only runs in a node.js environment
*/
export declare class WebsocketServer extends EventEmitter {
config: WebServerConfig;
wsServer: WsServer;
connectionId: number;
constructor(config: WebServerConfig);
/**
* method to start listening on incoming websocket connections. Incoming websocket connections are validated if they accept jet protocol
*/
listen(): void;
/** Method to stop Websocket server */
close(): void;
}