Skip to content

feat(workflow): support TypeInfo on Signal definitions - #2318

Open
THardy98 wants to merge 4 commits into
mainfrom
feat/ts-type-hints-signal-definitions
Open

feat(workflow): support TypeInfo on Signal definitions#2318
THardy98 wants to merge 4 commits into
mainfrom
feat/ts-type-hints-signal-definitions

Conversation

@THardy98

Copy link
Copy Markdown
Contributor

What was changed

Signal definitions can now provide input TypeInfo. The SDK applies that information when encoding Client signals, signal-with-start requests, and Workflow-originated external or child signals, and when decoding arguments for Workflow Signal handlers.

This is limited to definition-supplied type information. String-named Signal call sites will be addressed separately.

Why?

Signal arguments currently lose application-specific types at payload conversion boundaries. Carrying TypeInfo on the Signal definition lets callers and handlers consistently apply the same conversion contract.

This API is experimental. Existing Signals without type information retain their current conversion behavior, with no rollout or manual steps required.

Checklist

  1. Closes: N/A

  2. How was this tested: Repository build; ESLint and Prettier checks; workspace package lint checks; commit lint; and all 12 focused TypeInfo integration tests, covering Client, signal-with-start, external Workflow, child Workflow, and handler conversion paths.

  3. Any docs updates needed? No; documentation will accompany the completed experimental API.

@THardy98
THardy98 marked this pull request as ready for review August 13, 2026 20:53
@THardy98
THardy98 requested review from a team as code owners August 13, 2026 20:53
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.

1 participant