src/utils/ws.ts (1)

24-28: Add @param JSDoc tag for documentation generation.

The JSDoc comment lacks a @param tag, which likely causes the auto-generated documentation to show an empty signature defineWebSocketHandler(). Adding parameter documentation will improve both the generated docs and IDE intellisense.

 /**
  * Define WebSocket event handler.
  *
+ * @param hooks - WebSocket hooks object or a function that receives an H3Event and returns hooks
  * @see https://h3.dev/guide/websocket
  */

test/ws.test.ts (1)

23-30: Test looks good; consider adding async function test.

The test correctly verifies the synchronous function argument case. Since the type signature supports Promise<Partial<WebSocketHooks>>, consider adding a test for the async case to ensure the Promise is correctly passed through.

   it("should attach the provided hooks with function argument", () => {
     const wsHandler = defineWebSocketHandler(() => hooks);
     const res = wsHandler({} as any);
     expect(res).toBeInstanceOf(Response);
     expect((res as Response).status).toBe(426);
     // expect((res as Response).statusText).toBe("Upgrade Required");
     expect((res as any).crossws).toEqual(hooks);
   });
+
+  it("should attach the provided hooks with async function argument", async () => {
+    const wsHandler = defineWebSocketHandler(async () => hooks);
+    const res = wsHandler({} as any);
+    expect(res).toBeInstanceOf(Response);
+    expect((res as Response).status).toBe(426);
+    // crossws should be a Promise that resolves to hooks
+    await expect((res as any).crossws).resolves.toEqual(hooks);
+  });
 });

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro