@rsbuild/core 2.0.7 → 2.0.9

package/dist-types/server/socketServer.d.ts

@@ -5,12 +5,11 @@ export type ServerMessageFullReload = {
     type: 'full-reload';
     data?: {
         /**
-         * If `path` ends with `.html`, only the matching page will reload.
-         * The HTML path should be relative to the dev server root and should not
-         * include `server.base`. Use `'*'` to reload all pages.
-         * @example `/foo.html`
-         */
-        path?: string;
+     * If `path` ends with `.html`, only the matching page will reload.
+     * The HTML path should be relative to the dev server root and should not
+     * include `server.base`. Use `'*'` to reload all pages.
+     * @example `/foo.html`
+     */ path?: string;
     };
 };
 export type ServerMessageStaticChanged = {
@@ -73,32 +72,39 @@ export declare class SocketServer {
     private reportedBrowserLogs;
     private currentHash;
     constructor(context: InternalContext, options: DevConfig, getOutputFileSystem: () => Rspack.OutputFileSystem);
+    // subscribe upgrade event to handle socket
     upgrade: (req: IncomingMessage, socket: Socket, head: Buffer) => void;
+    // detect and close broken connections
+    // https://github.com/websockets/ws/blob/8.18.0/README.md#how-to-detect-and-close-broken-connections
     private checkSockets;
     private clearHeartbeatTimer;
+    // create socket, install socket handler, bind socket event
     prepare(): Promise<void>;
     onBuildDone(): void;
     /**
-     * Send error messages to the client.
-     */
-    sendError(errors: Rspack.StatsError[], token: string): void;
+   * Send error messages to the client.
+   */ sendError(errors: Rspack.StatsError[], token: string): void;
     /**
-     * Send warning messages to the client
-     */
-    sendWarning(warnings: Rspack.StatsError[], token: string): void;
+   * Send warning messages to the client
+   */ sendWarning(warnings: Rspack.StatsError[], token: string): void;
     /**
-     * Send a server message to matching client sockets.
-     * @param message - The message to send
-     * @param token - The token of the socket to send the message to,
-     * if not provided, the message will be sent to all sockets
-     */
-    sendMessage(message: ServerMessage, token?: string): void;
+   * Send a server message to matching client sockets.
+   * @param message - The message to send
+   * @param token - The token of the socket to send the message to,
+   * if not provided, the message will be sent to all sockets
+   */ sendMessage(message: ServerMessage, token?: string): void;
     close(): Promise<void>;
     private onConnect;
     private getEnvironmentByToken;
     private getInitialChunks;
+    // Cache initial chunks for environments that have no baseline yet.
+    // This keeps comparison stable even when no client socket is connected
+    // during the first completed build.
     private ensureInitialChunks;
+    // Only use stats when environment is matched
     private getStats;
+    // determine what message should send by stats
     private sendStats;
+    // send a serialized message to a specific socket
     private sendRawMessage;
 }

package/dist-types/server/watchFiles.d.ts

@@ -11,4 +11,4 @@ export type WatchFilesResult = {
 };
 export declare function setupWatchFiles(options: WatchFilesOptions): Promise<WatchFilesResult | undefined>;
 export declare function createChokidar(pathOrGlobs: string[], root: string, options: ChokidarOptions): Promise<FSWatcher>;
-export {};
+export { };