temporalio / temporalio/sdk-typescript
[Bug] Update documentation and examples on how to use typedSearchAttributes
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 917
- Forks
- 224
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 43
Description
What are you really trying to do?
I am trying to migrate to typedSearchAttributes instead of WorkflowOptions. searchAttributes which is marked as deprecated.
Describe the bug
Documentation still mentions only searchAttributes at https://docs.temporal.io/develop/typescript/observability without the concrete examples how to use typedSearchAttributes
Minimal Reproduction
Not applicable
Environment/Versions
@temporalio/common": "^1.13.2"
Contributor guide
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
Start with the TypeScript observability documentation at https://docs.temporal.io/develop/typescript/observability and compare its searchAttributes guidance with the typedSearchAttributes API. Update the examples to show typedSearchAttributes usage alongside the deprecated WorkflowOptions.searchAttributes, then verify the documentation clearly supports migration.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100