vite Architecture Docs
Home / Type/ WebSocketServer Type — vite Architecture

WebSocketServer Type — vite Architecture

Architecture documentation for the WebSocketServer type/interface in ws.ts from the vite codebase.

Type typescript

Entity Profile

Dependency Diagram

graph TD
  fd1e3cff_0288_ebdb_13c5_901cd884e874["WebSocketServer"]
  cab2c96f_4573_f58d_dd64_51e96c3e5033["ws.ts"]
  fd1e3cff_0288_ebdb_13c5_901cd884e874 -->|defined in| cab2c96f_4573_f58d_dd64_51e96c3e5033
  style fd1e3cff_0288_ebdb_13c5_901cd884e874 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/vite/src/node/server/ws.ts lines 43–73

export interface WebSocketServer extends NormalizedHotChannel {
  /**
   * Handle custom event emitted by `import.meta.hot.send`
   */
  on: WebSocketTypes.Server['on'] & {
    <T extends string>(
      event: T,
      listener: WebSocketCustomListener<InferCustomEventPayload<T>>,
    ): void
  }
  /**
   * Unregister event listener.
   */
  off: WebSocketTypes.Server['off'] & {
    (event: string, listener: Function): void
  }
  /**
   * Listen on port and host
   */
  listen(): void
  /**
   * Disconnect all clients and terminate the server.
   */
  close(): Promise<void>

  [isWebSocketServer]: true
  /**
   * Get all connected clients.
   */
  clients: Set<WebSocketClient>
}

Defined In

Source

Frequently Asked Questions

What is the WebSocketServer type?
WebSocketServer is a type/interface in the vite codebase, defined in packages/vite/src/node/server/ws.ts.
Where is WebSocketServer defined?
WebSocketServer is defined in packages/vite/src/node/server/ws.ts at line 43.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free