docs

Ease docs/Web

Web SDK

The Ease surface in TypeScript. One npm install, browser and Node 20+, with libsignal-wasm bundled so there is no separate artefact to fetch.

The Web SDK brings the Ease surface to TypeScript. It ships a bundled ESM entry, minified production builds, and full .d.ts declarations. The libsignal-wasm that backs end-to-end encryption rides inside the package, so there is nothing else to fetch.

Install

Shell
npm install @securegroupchat/web-sdk

No peer dependencies to wire up. The web SDK is the contract-verified reference implementation: every code sample in the quickstart and concepts compiles against it.

Platform support

  • Modern browsers with WebAssembly and IndexedDB.
  • Node 20+ for server-side use.

The shape is the same everywhere

The Web SDK exposes the same surface as every Ease SDK: ease.me, ease.auth, ease.contacts, and ease.chat. The quickstart walks the full flow with language-selectable code, and the concept pages cover each surface in depth.

See also

GuideQuickstartConnect, sign up, and send your first encrypted message. The language-selectable integration guide.ReferenceFull API referenceEvery method on the Ease facade plus the room handles and type definitions. Single page, Ctrl-F friendly.ConceptEncryption and local stateWhat the SDK stores on the device, what survives sign-out, and the web security model.ChangelogWeb SDK changelogOne entry per published version, newest first. What changed for you in each release.