Skip to content

docs: document status-dependent action attempt values - #1024

Merged
razor-x merged 1 commit into
mainfrom
claude/action-attempt-status-annotations-f216kn
Aug 27, 2026
Merged

docs: document status-dependent action attempt values#1024
razor-x merged 1 commit into
mainfrom
claude/action-attempt-status-annotations-f216kn

Conversation

@razor-x

@razor-x razor-x commented Aug 27, 2026

Copy link
Copy Markdown
Member

Follow-up to #1022: documents the status-discriminated ActionAttempt union in the README's Action Attempts section — how error and result are typed null outside their status, with a narrow-on-status example:

if (actionAttempt.status === 'success') {
  console.log(actionAttempt.result) // The result is non-null here.
}

if (actionAttempt.status === 'error') {
  console.log(actionAttempt.error.message) // The error is non-null here.
}

Also points to the exported SucceededActionAttempt / FailedActionAttempt types. README-only change; prettier passes.

🤖 Generated with Claude Code

https://claude.ai/code/session_01EdWS7o3htQ9cNxhCWL5Frp


Generated by Claude Code

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EdWS7o3htQ9cNxhCWL5Frp
@razor-x
razor-x requested a review from a team as a code owner August 27, 2026 16:35
@razor-x
razor-x merged commit a516562 into main Aug 27, 2026
16 checks passed
@razor-x
razor-x deleted the claude/action-attempt-status-annotations-f216kn branch August 27, 2026 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants