docs: Document custom serializable exceptions#573
Open
loopassembly wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds documentation explaining how to create and register custom exceptions that can be safely serialized and sent from Serverpod server to client.
Changes:
- Documented
SerializableExceptionimplementation for shared Dart exceptions - Documented registering shared exceptions via
extraClassesinconfig/generator.yaml
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+67
to
+69
| class UserFacingException implements SerializableException { | ||
| final String message; | ||
| final String? code; |
Comment on lines
+101
to
+102
| extraClasses: | ||
| - package:my_project_shared/my_project_shared.dart:UserFacingException |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
SerializableException.extraClassesentry so generated serialization can reconstruct them on the client.Verification
npx --yes --cache ./.npm-cache markdownlint-cli docs/06-concepts/04-exceptions.mdgit diff --checkI did not run a docs build because
serverpod_docs/AGENTS.mdsays not to run build commands locally.Closes serverpod/serverpod#3421