PartyKit PartySocket (Client API)

Browser and runtime client library for connecting to a PartyKit server over WebSockets. Wraps the standard WebSocket API with reconnection, buffering, and resilience. Runs in Web, ServiceWorker, Node.js, React Native, Cloudflare Workers, Deno, and Bun.

API entry from apis.yml

apis.yml Raw ↑
aid: partykit:partysocket
name: PartyKit PartySocket (Client API)
description: Browser and runtime client library for connecting to a PartyKit server over WebSockets. Wraps
  the standard WebSocket API with reconnection, buffering, and resilience. Runs in Web, ServiceWorker,
  Node.js, React Native, Cloudflare Workers, Deno, and Bun.
humanURL: https://docs.partykit.io/reference/partysocket-api/
baseURL: https://docs.partykit.io/reference/partysocket-api/
tags:
- Client SDK
- WebSockets
- Browser
- Cross-Runtime
properties:
- type: Documentation
  url: https://docs.partykit.io/reference/partysocket-api/
- type: SDK
  url: https://www.npmjs.com/package/partysocket