Skip to content

Broken TypeScript sample in your Client SDK docs #5200

Description

@David19876543210

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions