Guilherme SouzaandClaude Sonnet 4.6
296912fffa
## Summary - Adds a warning note to `onAuthStateChange()` that an `onError` handler is **required** - Updates all three Dart code examples (spotlight, specific-event, unsubscribe) to include `onError` ## Background Network errors (e.g. a token refresh attempted while the device is offline) are emitted as stream errors on `onAuthStateChange`. If no `onError` handler is provided, Dart rethrows them as unhandled zone exceptions, crashing the app. This is tracked in supabase/supabase-flutter#1281. The SDK itself already handles this internally (`supabase_auth.dart` has its own `onError`), but user-facing code that calls `.listen()` without `onError` is still vulnerable. The companion SDK fix (example app + doc comment in `gotrue_client.dart`) is in a separate PR in `supabase/supabase-flutter`. ## Test plan - [ ] Review the rendered diff in the Dart reference docs (`/docs/reference/dart/auth-onauthstatechange`) - [ ] Confirm all three code examples now show `onError` - [ ] Confirm the new note is visible in the Notes section 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Clarified auth-state change docs to require explicit error handling in listeners and updated all examples to show an error callback to avoid unhandled exceptions. * Updated the documented list of auth event names to the new set (including initialSession and mfaChallengeVerified) and adjusted examples accordingly. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Reference Docs
Supabase Reference Docs
Maintainers
If you are a maintainer of any tools in the Supabase ecosystem, you can use this site to provide documentation for the tools & libraries that you maintain.
Versioning
All tools have versioned docs, which are kept in separate folders. For example, the CLI has the following folders and files:
cli: the "next" release.cli_spec: contains the DocSpec for the "next" release (see below).cli_versioned_docs: a version of the documentation for every release (including the most current version).cli_versioned_sidebars: a version of the sidebar for every release (including the most current version).
When you release a new version of a tool, you should also release a new version of the docs. You can do this via the command line. For example, if you just released the CLI version 1.0.1:
npm run cli:version 1.0.1
DocSpec
We use documentation specifications which can be used to generate human-readable docs.
- OpenAPI: for documenting API endpoints.
- SDKSpec (custom to Supabase): for SDKs and client libraries.
- ConfigSpec (custom to Supabase): for configuration options.
- CLISpec (custom to Supabase): for CLI commands and usage.
The benefit of using custom specifications is that we can generate many other types from a strict schema (eg, HTML and manpages). It also means that we can switch to any documentation system we want. On this site we use Next.js, but on Supabase's official website, we use a custom React site and expose only a subset of the available API for each tool.
Contributing
To contribute to docs, see the developers' guide and contributing guide.