docs: update readmes

Author: aleclarson

src/adapters/bun/readme.md

@@ -26,6 +26,21 @@ export default bunAdapter(compose(ws.handler, httpHandler), {
 
 3. Refer to [this guide](https://crossws.unjs.io/guide/hooks) for the available hooks.
 
+### Peer context
+
+Every hook (except `upgrade`) receives a [peer](https://crossws.unjs.io/guide/peer) as its first argument.
+
+Each peer has a `context` property that contains the Hattip context, which your Hattip middlewares can define new properties on.
+
+The following properties are always available on `peer.context`:
+
+- `url: URL` The URL that facilitated the WebSocket upgrade.
+- `env: (name: string) => string` A function to access environment variables in a platform-agnostic way.
+- `locals: Record<string, unknown>` A mutable object that can be used to store data for the duration of the WebSocket connection.
+- `platform: BunPlatformInfo`
+  - `name: "bun"`
+  - `server: Server` The Bun server instance.
+
 ### WebSocketAdapter API
 
 The adapter returned by the `createWebSocketAdapter` function has the following properties:

src/adapters/cloudflare-workers/readme.md

@@ -26,6 +26,22 @@ export default {
 
 3. Refer to [this guide](https://crossws.unjs.io/guide/hooks) for the available hooks.
 
+### Peer context
+
+Every hook (except `upgrade`) receives a [peer](https://crossws.unjs.io/guide/peer) as its first argument.
+
+Each peer has a `context` property that contains the Hattip context, which your Hattip middlewares can define new properties on.
+
+The following properties are always available on `peer.context`:
+
+- `url: URL` The URL that facilitated the WebSocket upgrade.
+- `env: (name: string) => string` A function to access environment variables in a platform-agnostic way.
+- `locals: Record<string, unknown>` A mutable object that can be used to store data for the duration of the WebSocket connection.
+- `platform: CloudflareWorkersPlatformInfo`
+  - `name: "cloudflare-workers"`
+  - `env: unknown` [Bindings](https://developers.cloudflare.com/workers/configuration/bindings) for secrets, [environment variables](https://developers.cloudflare.com/workers/platform/environment-variables), and other resources like KV namespaces, etc.
+  - `context: ExecutionContext` The Cloudflare Workers execution context.
+
 ### WebSocketAdapter API
 
 The adapter returned by the `createWebSocketAdapter` function has the following properties:

src/adapters/deno/readme.md

@@ -24,6 +24,21 @@ Deno.serve(createServeHandler(compose(ws.handler, httpHandler)))
 
 3. Refer to [this guide](https://crossws.unjs.io/guide/hooks) for the available hooks.
 
+### Peer context
+
+Every hook (except `upgrade`) receives a [peer](https://crossws.unjs.io/guide/peer) as its first argument.
+
+Each peer has a `context` property that contains the Hattip context, which your Hattip middlewares can define new properties on.
+
+The following properties are always available on `peer.context`:
+
+- `url: URL` The URL that facilitated the WebSocket upgrade.
+- `env: (name: string) => string` A function to access environment variables in a platform-agnostic way.
+- `locals: Record<string, unknown>` A mutable object that can be used to store data for the duration of the WebSocket connection.
+- `platform: DenoPlatformInfo`
+  - `name: "deno"`
+  - `info: Deno.ServeInfo` The Deno serve info object.
+
 ### WebSocketAdapter API
 
 The adapter returned by the `createWebSocketAdapter` function has the following properties:

src/adapters/node/readme.md

@@ -27,6 +27,22 @@ export default server
 
 3. Refer to [this guide](https://crossws.unjs.io/guide/hooks) for the available hooks.
 
+### Peer context
+
+Every hook (except `upgrade`) receives a [peer](https://crossws.unjs.io/guide/peer) as its first argument.
+
+Each peer has a `context` property that contains the Hattip context, which your Hattip middlewares can define new properties on.
+
+The following properties are always available on `peer.context`:
+
+- `url: URL` The URL that facilitated the WebSocket upgrade.
+- `env: (name: string) => string` A function to access environment variables in a platform-agnostic way.
+- `locals: Record<string, unknown>` A mutable object that can be used to store data for the duration of the WebSocket connection.
+- `platform: NodePlatformInfo`
+  - `name: "node"`
+  - `request: http.IncomingMessage` The Node.js HTTP request object.
+  - `response: http.ServerResponse` The Node.js HTTP response object.
+
 ### WebSocketAdapter API
 
 The adapter returned by the `createWebSocketAdapter` function has the following properties: