docs: showcase await using pattern in README quickstart#104
Merged
Conversation
Replace the try/finally examples in Quick Start and Watch for Changes with `await using` / `using`, since ConfigClient and ConfigWatcher both implement Symbol.asyncDispose. Fold the old try/finally snippet into a <details> block so readers who need it can still find it. Also update examples/quickstart/main.ts to use `await using` so the runnable example matches the README. Closes #68 Co-Authored-By: Claude <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
await usingas the primary resource-management pattern in the README, sinceConfigClientandConfigWatcherboth implementSymbol.asyncDispose— readers should see the flagship TS 5.2 feature front and center, not buried or absent.<details>block so it remains discoverable without competing withawait using.examples/quickstart/main.tsto match — the runnable example now demonstratesawait usinginstead of try/finally.Test plan
npm run typecheck)npm run lint)<details>block collapses)Closes #68