Skip to content

Mark client context as deprecated #67

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
k0d13 merged 2 commits into from
Feb 27, 2025
Merged

Mark client context as deprecated #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99763c2
Deprecate client context
k0d13 Feb 27, 2025
6e6d5c3
Add changeset
k0d13 Feb 27, 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
5 changes: 5 additions & 0 deletions .changeset/shiny-symbols-rescue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"next-ws": patch
---

Mark client context as deprecated
2 changes: 2 additions & 0 deletions src/client/context.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ export const WebSocketConsumer = WebSocketContext.Consumer;
* allowing for easy access to the WebSocket from anywhere in the app.
* @param props WebSocket parameters and children.
* @returns JSX Element
* @deprecated `WebSocketProvider` is deprecated, use your own implementation instead.
*/
export function WebSocketProvider(
p: React.PropsWithChildren<{
Expand Down Expand Up @@ -53,6 +54,7 @@ export function WebSocketProvider(
/**
* Access the websocket from anywhere in the app, so long as it's wrapped in a WebSocketProvider.
* @returns WebSocket client when connected, null when disconnected.
* @deprecated `useWebSocket` is deprecated, use your own implementation instead.
*/
export function useWebSocket() {
const context = useContext(WebSocketContext);
Expand Down