Document @solana/errors with TypeDoc
#66
Open
Conversation
This file contains 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
|
BundleMonFiles updated (3)
Unchanged files (124)
Total files change +497B +0.14% Final result: ✅ View report in BundleMon website ➡️ |
steveluscher
commented
Jan 16, 2025
Comment on lines
+6
to
+12
| * A type guard that returns `true` if the input is a {@link SolanaError}, optionally with a | ||
| * particular error code. | ||
| * | ||
| * When the `code` argument is supplied and the input is a {@link SolanaError}, TypeScript will | ||
| * refine the error's {@link SolanaError#context | `context`} property to the type associated with | ||
| * that error code. You can use that context to render useful error messages, or to make | ||
| * context-aware decisions that help your application to recover from the error. |
There was a problem hiding this comment.
Hopefully documenting this here will make it show in in people's autocomplete, then they'll see the example, and better understand how to take advantage of the full power of this assertion.
Comment on lines
+29
to
+34
| * > [!IMPORTANT] | ||
| * > The string representation of a {@link SolanaError} should not be shown to users. Developers | ||
| * > should use {@link isSolanaError} to distinguish the type of a thrown error, then show a custom, | ||
| * > localized error message appropriate for their application's audience. Custom error messages | ||
| * > should use the error's {@link SolanaError#context | `context`} if it would help the reader | ||
| * > understand what happened and/or what to do next. |
steveluscher
force-pushed
the
01-16-document_solana_errors_with_typedoc
branch
from
2195610 to
0433a03
Compare
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.
This PR moves content from the README into the code.
Addresses #50
Test Plan
cd packages/errors pnpm typedoc --watch \ --plugin typedoc-plugin-missing-exports \ --plugin typedoc-plugin-mdn-links python3 -m http.server -d docsPreview here: https://silly-creponne-8b5941.netlify.app/