Client
Installation
Install and import `@sockudo/client` by runtime target.
Install
Terminal
npm install @sockudo/client
or
Terminal
bun add @sockudo/client
Runtime Entry Points
// Browser/default
import Pusher from "@sockudo/client";
// Filter utilities
import { Filter } from "@sockudo/client/filter";
// Encrypted channels build
import PusherEncrypted from "@sockudo/client/with-encryption";
// Worker
import WorkerPusher from "@sockudo/client/worker";
// Worker with encryption
import WorkerEncrypted from "@sockudo/client/worker/with-encryption";
// React Native (work in progress)
import ReactNativePusher from "@sockudo/client/react-native";
Native iOS (Swift) and Android (Kotlin) clients are currently work in progress. The React Native entry point provides mobile support for JavaScript-based apps.
Basic Connect
import Pusher from "@sockudo/client";
const pusher = new Pusher("app-key", {
cluster: "mt1",
wsHost: "127.0.0.1",
wsPort: 6001,
wssPort: 443,
forceTLS: false,
enabledTransports: ["ws", "wss"],
});
Runtime Requirements
- Node.js
>=22 - Bun
>=1.0.0(development workflows)