Repository navigation
Fix TypeScript samples that use APIs missing from @temporalio 1.24.0 - #5411
Merged
Merged
Conversation
- fixed-count-retries: import RetryState from @temporalio/common; the workflow package doesn't re-export it. - fixed-wall-time-retries: TimeoutFailure has timeoutType, not type; import TimeoutType from @temporalio/common. - testing-suite: fix the heatbeat import typo. - temporal-client: client.getHandle() was the old WorkflowClient API; use client.workflow.getHandle(). Drop the redundant second handle declaration in the start sample. - workflow-streams: the TypeScript SDK has no executeActivity; call the Activity through proxyActivities.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📖 Docs PR preview links
|
Duncanma
enabled auto-merge (squash)
October 5, 2026 20:21
flippedcoder
approved these changes
Oct 5, 2026
This branch was successfully deployed
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.
Fixes hand-written TypeScript samples that call APIs the latest
@temporaliopackages (1.24.0) don't have. Each was confirmed against the published.d.tsfiles.Changes
docs/design-patterns/fixed-count-retries.mdx:wf.RetryStatedoesn't exist because@temporalio/workflowdoesn't re-export it. The sample now importsRetryStatefrom@temporalio/common.docs/design-patterns/fixed-wall-time-retries.mdx:TimeoutFailurehastimeoutType, nottype, andwf.TimeoutTypeisn't exported. The sample now usescause.timeoutTypeand importsTimeoutTypefrom@temporalio/common.docs/develop/typescript/best-practices/testing-suite.mdx: Fixed theheatbeatimport typo, which is nowheartbeat.docs/develop/typescript/client/temporal-client.mdx:client.getHandle()came from the oldWorkflowClientAPI, so the two result samples now useclient.workflow.getHandle(). The "Start a Workflow Execution" sample declaredconst handletwice. It already gets a handle fromclient.workflow.start(), so I removed the second declaration.docs/develop/typescript/workflows/workflow-streams.mdx: The TypeScript SDK has noexecuteActivity. The LLM streaming Workflow now calls the Activity throughproxyActivities<typeof activities>(), like the rest of the TypeScript docs.Not in this PR
The code comment on
temporal-client.mdxthat points to/typescript/security#encryption-in-transit-with-mtlsis in the Worker sample that #5407 moves to Snipsync, and that change removes the comment. I left the block alone to avoid a conflict. #5407's commit rebases cleanly onto this branch.Checks
vale --config .vale-ci.inion the five pages: 0 errors and 0 warnings. Three suggestions remain on lines 611–625 oftemporal-client.mdx, which this PR doesn't change.bin/check-typescript-samples.js --sdk-version 1.24.0) on the five pages. It's not onmainyet. It checked 55 samples. Of its 9 findings onmain, only the comment link that Source TypeScript Task Queue samples from samples-typescript via Snipsync #5407 handles remains.