temporalio / temporalio/documentation
Broken TypeScript sample in your Client SDK docs
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 173
- Forks
- 330
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 156
Description
I ran a checker over your docs and 1 of the TypeScript samples doesn't compile
against @temporalio/client@1.23.0. On the Temporal Client TypeScript SDK >
Start Workflow Execution > Set a Workflow's Task Queue page:
const connection = await Connection.create({ address: 'localhost:7233' });
// TS error: Property 'create' does not exist on type 'typeof Connection'.
The current SDK's static methods are Connection.connect() and
Connection.lazy() — there's no .create().
I think it's drift between the published package and the docs rather than a
mistake in the sample.
I'm building a small CLI that catches this in CI. Two questions if you have a
minute: does this kind of thing get reported to you by users, and is it
something anyone currently owns?
Happy to share the full JSON report if that's useful — just ask.
David
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the Temporal Client TypeScript SDK "Start Workflow Execution > Set a Workflow's Task Queue" documentation page and locate the sample using Connection.create(). Check the example against @temporalio/client@1.23.0 and verify that the corrected sample compiles with the current Connection API.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 84/100