Merge pull request #17 from thefrontside/tm/improve-type-presentation

Added support for multiple type declarations and cleaned up styling
thefrontside · Oct 4, 2024 · 949d5b2 · 949d5b2
2 parents df6d765 + 97fb90a
commit 949d5b2
Show file tree

Hide file tree

Showing 9 changed files with 238 additions and 121 deletions.
diff --git a/deno.json b/deno.json
@@ -29,7 +29,6 @@
     "./deno-deploy",
     "./task-buffer",
     "./tinyexec",
-    "./examples",
     "./websocket"
   ]
 }
diff --git a/examples/deno.json b/examples/deno.json
diff --git a/examples/mod.ts b/examples/mod.ts
diff --git a/examples/use-message.ts b/examples/use-message.ts
diff --git a/websocket/websocket.ts b/websocket/websocket.ts
@@ -48,13 +48,12 @@ export interface WebSocketResource<T>
  *   console.log('event data: ', event.data);
  *   yield* each.next();
  * }
- *
  * ```
  *
  * @param url - The URL of the target WebSocket server to connect to. The URL must use one of the following schemes: ws, wss, http, or https, and cannot include a URL fragment. If a relative URL is provided, it is relative to the base URL of the calling script. For more detail, see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/WebSocket#url
  *
  * @param prototol - A single string or an array of strings representing the sub-protocol(s) that the client would like to use, in order of preference. If it is omitted, an empty array is used by default, i.e. []. For more details, see
-
+ *
  * @returns an operation yielding a {@link WebSocketResource}
  */
 export function useWebSocket<T>(
@@ -66,7 +65,7 @@ export function useWebSocket<T>(
  * Create a [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket)
  * resource, but delegate the creation of the underlying websocket to a function
  * of your choice. This is necessary on platforms that do not have a global
- * `WebSocket` constructor such as NodeJS <= 20.
+ * `WebSocket` constructor such as NodeJS \<= 20.
  *
  * The resource will not be returned until a connection has been
  * succesffuly established with the server and the
@@ -164,7 +163,4 @@ export function useWebSocket<T>(
   });
 }
 
-/**
- * @ignore until we can get jsdocs working for type unions
- */
 export type WebSocketData = Parameters<WebSocket["send"]>[0];