centrifuge-js

This SDK provides a client to connect to Centrifugo or any Centrifuge-based server using pure WebSocket or one of the alternative transports (HTTP-streaming, SSE/EventSource, experimental WebTransport) from web browser, ReactNative, or NodeJS environments.

[!IMPORTANT]
This library behaves according to a common Centrifugo SDK spec. It's recommended to read that before starting to work with this SDK as the spec covers common SDK behavior - describes client and subscription state transitions, main options and methods. Then proceed with this readme for more specifics about centrifuge-js.

The features implemented by this SDK can be found in SDK feature matrix.

centrifuge-js v5.x is compatible with Centrifugo server v6, v5 and v4, and Centrifuge >= 0.25.0. For Centrifugo v2, Centrifugo v3 and Centrifuge < 0.25.0 you should use centrifuge-js v2.x.

• Install
• Quick start
• Supported real-time transports
  • WebSocket transport
  • HTTP-based WebSocket fallbacks
  • Using SockJS
  • WebTransport (experimental)
• Client API
  • Client methods and events
  • Client options
  • Connection token
• Subscription API
  • Subscription methods and events
  • Subscription token
  • Subscription options
• Subscription management API
• Stream subscriptions with getState
• Map subscriptions (experimental)
• Shared poll subscriptions (experimental)
• Message batching
• Server-side subscriptions