Skip to content

Fix data channels docs #462

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
czerwiukk merged 1 commit into from
Jan 28, 2026
Merged

Fix data channels docs #462

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions packages/react-client/src/types/public.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,14 +93,14 @@ export type UseDataChannelResult = {
/**
* Sends binary data through a data channel.
* @param payload - The Uint8Array payload to send (first positional argument)
* @param options - Data channel options; specify { reliable: true } for guaranteed delivery or { reliable: false } for low latency
* @param options - Data channel options; specify `reliable: true` for guaranteed delivery or `reliable: false` for low latency
*/
publishData: (payload: Uint8Array, options: DataChannelOptions) => void;
/**
* Subscribe to incoming data on a data channel.
* Can be called before or after channel creation.
* @param callback - Function called when data is received
* @param options - Specify { reliable: true } or { reliable: false } to choose channel
* @param options - Specify `reliable: true` or `reliable: false` to choose channel
* @returns Unsubscribe function - call to cancel the subscription
*/
subscribeData: (callback: DataCallback, options: DataChannelOptions) => () => void;
Expand Down
Loading