Conversation
There was a problem hiding this comment.
Pull request overview
This PR significantly modernizes and improves the README.md documentation for the Durable Task SDK for JavaScript/TypeScript. The update clarifies the SDK's purpose and relationship to Azure services, provides comprehensive usage examples with modern TypeScript patterns, and streamlines development instructions.
Changes:
- Updated project description with build status/license badges, clarified relationship to Azure Durable Functions and Azure Durable Task Scheduler, added npm package table, and updated Node.js requirement to 22+
- Replaced outdated code examples with modern TypeScript-based samples demonstrating orchestrations (function chaining, fan-out/fan-in, human interaction, entities) using Azure Managed SDK patterns with
createAzureManagedClientandcreateAzureManagedWorkerBuilder - Streamlined development instructions for protobuf generation to use
npm run generate-grpc, removed outdated testing instructions, and updated Microsoft trademark guidelines URL
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # DurableTask Javascript | ||
| # Durable Task SDK for JavaScript/TypeScript | ||
|
|
||
| [](https://github.com/microsoft/durabletask-js/actions) |
There was a problem hiding this comment.
The workflow file referenced in the build status badge does not exist. The badge points to validate-build.yml, but the actual workflow file is pr-validation.yaml. The badge URL should be updated to reference the correct workflow file.
| [](https://github.com/microsoft/durabletask-js/actions) | |
| [](https://github.com/microsoft/durabletask-js/actions) |
| const winner = yield whenAny([approvalEvent, timeoutEvent]); | ||
|
|
||
| if (winner == timeoutEvent) { | ||
| return "Cancelled"; |
There was a problem hiding this comment.
The comment states "Approvals must be received within 24 hours or they will be canceled" (American spelling), but the return value uses "Cancelled" (British spelling). For consistency within the same code example, both should use the same spelling variant. The American spelling "Canceled" is more common in programming contexts and would be consistent with the comment.
| return "Cancelled"; | |
| return "Canceled"; |
This pull request significantly improves and updates the
README.mdfor the Durable Task SDK for JavaScript/TypeScript. The changes modernize the documentation, clarify the relationship to Azure Durable Functions, add clear usage instructions, and provide more comprehensive and up-to-date examples for orchestrations and entities. The protobuf generation and testing instructions have also been streamlined.Key improvements and updates:
1. Documentation modernization and clarification
2. Expanded and improved usage examples
examplesdirectory. [1] [2]addNamedEntityand improved entity registration and access patterns.3. Development workflow and protobuf instructions
npm run generate-grpcand clarified the download process for proto files.4. Minor corrections and legal updates