feat: add type guard helpers for ContentBlock variants#975
Open
ac12644 wants to merge 1 commit intoanthropics:mainfrom
Open
feat: add type guard helpers for ContentBlock variants#975ac12644 wants to merge 1 commit intoanthropics:mainfrom
ac12644 wants to merge 1 commit intoanthropics:mainfrom
Conversation
Adds 12 type guard functions (isTextBlock, isToolUseBlock, etc.) that
narrow ContentBlock to its specific variant. Exported from the package
root so users can write:
import { isTextBlock } from '@anthropic-ai/sdk';
const textBlocks = message.content.filter(isTextBlock);
Includes compile-time exhaustiveness test that fails if a new
ContentBlock variant is added without a corresponding guard.
Closes anthropics#432
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
isTextBlock,isToolUseBlock,isThinkingBlock, etc.) that narrowContentBlockto its specific variantContentBlockvariant is added without a corresponding guardMotivation
Addresses #432 — the most upvoted open issue (15+ thumbs up). Since v0.22.0,
ContentBlockis a 12-member union, somsg.content[0].textrequires type narrowing. Users currently resort toascasts or// @ts-ignore.With this change:
Design decisions
create()based ontoolspresence would be type-unsound (thinking, server tools, etc. can produce non-text blocks even withouttools). Type guards are correct and composable.src/lib/placement: Hand-written helpers that survive Stainless code generation, following the existing pattern (parser.ts,MessageStream.ts).TracksToolInput.test.ts) so adding a newContentBlockvariant without a guard is a build error.Test plan
yarn lintpasses (types + eslint + prettier)TracksToolInput,index.test,parser.test)requireandimport)Closes #432