feat: convert Watcher class declaration to interfaces#33
Open
mrazauskas wants to merge 1 commit into
Open
Conversation
Signed-off-by: mrazauskas <tom@mrazauskas.de>
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.
Alternative to #32
This PR converts the
Watcherclass declaration to interfaces.As explained in #32, currently TypeScript reports declarations of
addListener()andremoveListener()as incompatible with the original class (see #31). When a class is converted into an interface, it is possible to useOmit<EventEmitter, 'addListener' | 'removeListener'>. This solves the problem.The only difference for a user is that it will not be possible to use
newonVFSStatWatcherand other classes. These classes are not exported fromindex.js. The type declaration model the return types ofwatch(),watchFile(), andwatchAsync(). So that shouldn’t be a problem.I suggest converting all three classes so that the return typings of all three watch methods are consistently modelled using interfaces.
Close #32