From dd5cb5bfa2c9fd8f7251e875157ee0239b7effa0 Mon Sep 17 00:00:00 2001
From: Joel Wetzell <git@jwetzell.com>
Date: Wed, 13 May 2026 19:17:19 -0500
Subject: [PATCH] add docs for websocket.client module

---
 astro.config.mjs                              |  5 +++++
 package-lock.json                             |  8 +++++++
 src/content/docs/modules/websocket/client.mdx | 21 +++++++++++++++++++
 3 files changed, 34 insertions(+)
 create mode 100644 src/content/docs/modules/websocket/client.mdx

diff --git a/astro.config.mjs b/astro.config.mjs
index 7529955..0a5a953 100644
--- a/astro.config.mjs
+++ b/astro.config.mjs
@@ -111,6 +111,11 @@ export default defineConfig({
                 },
               ],
             },
+            {
+              label: "WebSocket",
+              collapsed: true,
+              autogenerate: { directory: "modules/websocket" },
+            },
           ],
         },
         {
diff --git a/package-lock.json b/package-lock.json
index 35fd43d..58a51e9 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -2313,6 +2313,7 @@
       "integrity": "sha512-UVJyE9MttOsBQIDKw1skb9nAwQuR5wuGD3+82K6JgJlm/Y+KI92oNsMNGZCYdDsVtRHSak0pcV5Dno5+4jh9sw==",
       "dev": true,
       "license": "MIT",
+      "peer": true,
       "bin": {
         "acorn": "bin/acorn"
       },
@@ -2336,6 +2337,7 @@
       "integrity": "sha512-PlXPeEWMXMZ7sPYOHqmDyCJzcfNrUr3fGNKtezX14ykXOEIvyK81d+qydx89KY5O71FKMPaQ2vBfBFI5NHR63A==",
       "dev": true,
       "license": "MIT",
+      "peer": true,
       "dependencies": {
         "fast-deep-equal": "^3.1.3",
         "fast-uri": "^3.0.1",
@@ -2438,6 +2440,7 @@
       "integrity": "sha512-SRy1bONuCHkGWhI5JiWCQKVDVbeaXOikjAVZs/Nz+lvUvubtdLoZfnacmuZHQ9RL2IOkU54M8/qZYm9ypJDKrg==",
       "dev": true,
       "license": "MIT",
+      "peer": true,
       "dependencies": {
         "@astrojs/compiler": "^3.0.1",
         "@astrojs/internal-helpers": "0.8.0",
@@ -5760,6 +5763,7 @@
         }
       ],
       "license": "MIT",
+      "peer": true,
       "dependencies": {
         "nanoid": "^3.3.11",
         "picocolors": "^1.1.1",
@@ -5815,6 +5819,7 @@
       "integrity": "sha512-UOnG6LftzbdaHZcKoPFtOcCKztrQ57WkHDeRD9t/PTQtmT0NHSeWWepj6pS0z/N7+08BHFDQVUrfmfMRcZwbMg==",
       "dev": true,
       "license": "MIT",
+      "peer": true,
       "bin": {
         "prettier": "bin/prettier.cjs"
       },
@@ -6285,6 +6290,7 @@
       "integrity": "sha512-2oMpl67a3zCH9H79LeMcbDhXW/UmWG/y2zuqnF2jQq5uq9TbM9TVyXvA4+t+ne2IIkBdrLpAaRQAvo7YI/Yyeg==",
       "dev": true,
       "license": "MIT",
+      "peer": true,
       "dependencies": {
         "@types/estree": "1.0.8"
       },
@@ -6653,6 +6659,7 @@
       "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==",
       "dev": true,
       "license": "Apache-2.0",
+      "peer": true,
       "bin": {
         "tsc": "bin/tsc",
         "tsserver": "bin/tsserver"
@@ -7055,6 +7062,7 @@
       "integrity": "sha512-w+N7Hifpc3gRjZ63vYBXA56dvvRlNWRczTdmCBBa+CotUzAPf5b7YMdMR/8CQoeYE5LX3W4wj6RYTgonm1b9DA==",
       "dev": true,
       "license": "MIT",
+      "peer": true,
       "dependencies": {
         "esbuild": "^0.27.0",
         "fdir": "^6.5.0",
diff --git a/src/content/docs/modules/websocket/client.mdx b/src/content/docs/modules/websocket/client.mdx
new file mode 100644
index 0000000..fb42d4f
--- /dev/null
+++ b/src/content/docs/modules/websocket/client.mdx
@@ -0,0 +1,21 @@
+---
+title: WebSocket Client
+sidebar:
+    label: Client
+    order: 1
+---
+
+The `websocket.client` module opens a websocket connection to the specified URL. This module supports both text and binary websocket messages.
+
+- **type**: `websocket.client`
+- **params**:
+    - **url**: the full url to connect to (`wss://echo.websocket.org`)
+
+### Example
+Connect to the example WS server at `echo.websocket.org`.
+```yaml
+- id: websocket
+  type: websocket.client
+  params:
+    url: "wss://echo.websocket.org"
+```
\ No newline at end of file