feat(dispose): add Symbol.asyncDispose to ConfigClient and ConfigWatcher#82
Merged
Conversation
Symbol.dispose fires stop() as fire-and-forget, so callers using `await using` would not wait for cleanup to complete. Adding Symbol.asyncDispose lets the runtime await stop() properly. Also adds esnext.disposable to tsconfig lib so the symbol type is recognized by the compiler without a target bump. Closes #51 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
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
Symbol.disposeonConfigWatchercallsstop()via fire-and-forget (void this.stop()), soawait usingblocks would return before cleanup completed.Symbol.asyncDisposeto bothConfigClientandConfigWatcherso the runtime can properlyawaitthe teardown path.esnext.disposabletotsconfig.jsonlib so the compiler recognizes the symbol without bumping the compile target.Test plan
ConfigClient[Symbol.asyncDispose]()— closes both stubs and resolvesConfigClientwithawait using— stubs closed after block exitsConfigWatcher[Symbol.asyncDispose]()— awaitsstop()before resolving, stream cancelledConfigWatcherwithawait using— stream cancelled after block exitsCloses #51