Skip to content

docs: add docs for augmenting PeerContext type #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pi0 merged 2 commits into from
May 20, 2025
+10 −0
Merged

docs: add docs for augmenting PeerContext type #161

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f976ec
docs: add `PeerContext`
luc122c May 16, 2025
6f818c9
Update docs/1.guide/3.peer.md
pi0 May 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/1.guide/3.peer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,15 @@ Direct access to the [`WebSocket`](https://developer.mozilla.org/en-US/docs/Web/

### `peer.context`

The context is an object that contains arbitrary information about the request.
The context is an object that contains arbitrary information about the request. You can augment the `PeerContext` interface to add your own properties.
Comment thread
pi0 marked this conversation as resolved.
Outdated

```ts
declare module "crossws" {
interface PeerContext {
customData?: string[];
}
}
```

> [!NOTE]
> context data can be volatile in some runtimes.
Expand Down