supabase_realtime

Dart client library for Supabase Realtime, to listen to changes in a PostgreSQL database over websockets.

Guides · Reference Docs

Note

This package was published as realtime_client up to and including v2. That package is discontinued in favour of supabase_realtime.

Supabase Service Compatibility

supabase_realtime only guarantees compatibility with the latest Supabase Realtime release. Older Supabase Realtime releases are supported on a best-effort basis, but compatibility is not guaranteed.

If you self-host Supabase Realtime, we recommend upgrading to the latest release when upgrading this SDK.

Docs

The docs can be found on the official Supabase website.

• Dart reference
• Realtime guide

Testing

The unit tests run without any external services:

dart test -x integration

The integration tests in test/realtime_integration_test.dart run against a real Supabase Realtime server. Start the local Supabase stack with the CLI first (from the repository root), then run the full suite:

supabase start
dart test
supabase stop

License

This repo is licensed under MIT.

Credits

• https://github.com/supabase/realtime-js - ported from realtime-js library