Skip to content

Comments

Update README.md #110

Merged
torosent merged 1 commit intomainfrom
torosent/readme-change
Feb 18, 2026
Merged

Update README.md #110
torosent merged 1 commit intomainfrom
torosent/readme-change

Conversation

@torosent
Copy link
Member

This pull request significantly improves and updates the README.md for 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

  • Updated the project description to clarify its purpose and relationship to Azure Durable Functions, and added badges for build status and licensing.
  • Added a table listing available npm packages with descriptions and links.
  • Updated prerequisites to require Node.js 22+ and clarified backend requirements.

2. Expanded and improved usage examples

  • Replaced old code samples with modern, TypeScript-based examples for orchestrations (function chaining, fan-out/fan-in, human interaction with timers, and durable entities), including links to full samples in the examples directory. [1] [2]
  • Updated entity usage to use addNamedEntity and improved entity registration and access patterns.

3. Development workflow and protobuf instructions

  • Revised protobuf generation instructions to use npm run generate-grpc and clarified the download process for proto files.
  • Removed outdated and redundant instructions for running tests and sidecars.

4. Minor corrections and legal updates

  • Fixed outdated URLs, improved language, and updated the Microsoft trademark and brand guidelines link.…uctions

Copilot AI review requested due to automatic review settings February 18, 2026 17:08
@torosent torosent merged commit a8a6309 into main Feb 18, 2026
14 checks passed
@torosent torosent deleted the torosent/readme-change branch February 18, 2026 17:09
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 createAzureManagedClient and createAzureManagedWorkerBuilder
  • 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

[![Build status](https://github.com/microsoft/durabletask-js/actions/workflows/validate-build.yml/badge.svg)](https://github.com/microsoft/durabletask-js/actions)
Copy link

Copilot AI Feb 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
[![Build status](https://github.com/microsoft/durabletask-js/actions/workflows/validate-build.yml/badge.svg)](https://github.com/microsoft/durabletask-js/actions)
[![Build status](https://github.com/microsoft/durabletask-js/actions/workflows/pr-validation.yaml/badge.svg)](https://github.com/microsoft/durabletask-js/actions)

Copilot uses AI. Check for mistakes.
const winner = yield whenAny([approvalEvent, timeoutEvent]);

if (winner == timeoutEvent) {
return "Cancelled";
Copy link

Copilot AI Feb 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
return "Cancelled";
return "Canceled";

Copilot uses AI. Check for mistakes.
Copilot AI mentioned this pull request Feb 18, 2026
15 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants