docs: document SirenError hierarchy + error handling#3
Merged
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 52b164003d
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Documents all 11 SirenError subclasses with when-thrown + status codes and a real try/catch example branching on RateLimitError/ValidationError/NotFoundError. Docs-only; no behavior change. Charter: Q2hhcnRlcjo4MDI= Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0138jQKyzwyDfEbbAeMmYNnL
The try/catch example called events.sale({ orderId, amount }) — neither
field exists. SaleParams requires source/externalId/total/trackingId,
with total in major currency units. Align the example with the
quick-start snippet and clarify the NotFoundError branch comment.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0138jQKyzwyDfEbbAeMmYNnL
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0138jQKyzwyDfEbbAeMmYNnL
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0138jQKyzwyDfEbbAeMmYNnL
alexstandiford
force-pushed
the
rocky/document-error-handling
branch
from
July 20, 2026 01:44
9ab3cd5 to
56b4c26
Compare
The lead sentence overclaimed: code/statusCode are optional (ConnectionError and SignatureVerificationError carry no statusCode), invalid client configuration throws the base SirenError itself, and webhooks.constructEvent lets a native SyntaxError escape for a signed but non-JSON body. State the actual contract, document the two exceptions, and make the fallback branch not print 'undefined' for errors without a statusCode. Addresses the Codex P2 review findings on this PR. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0138jQKyzwyDfEbbAeMmYNnL
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
2 participants
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.
Adds an Error handling section to the README (11 error classes + a real try/catch example). Docs-only, low risk.
Charter: Q2hhcnRlcjo4MDI=