Documentation

Start with the quick start to get a working app in 30 seconds, or browse a topic below.

Quick Start

One command. Full project. Working realtime.

Manual Setup

Add svelte-realtime to an existing SvelteKit project.

RPC

Call server functions like local async functions.

Streams

Reactive stores that sync across clients in real time.

Merge Strategies

crud, set, latest, presence, cursor - pick how data merges.

Auth

Connection auth, module guards, access control.

Client APIs

Virtual imports, stores, pagination, optimistic updates.

Full API Reference

Every function, type, and option in one page.

Tutorial

Prefer hands-on learning? The interactive tutorial has 12 lessons where you write real code in a live editor.

Switching from another framework?

Coming from Socket.io Coming from Supabase Coming from Firebase

Was this page helpful?