fix: update VFSStatWatcher typings#32
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
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.
This PR updates typings of the
VFSStatWatcherclass.The problem is that
addListener()andremoveListener()are trying to override type declarations ofEventEmitterwith different implementations. For instance,addListener()declares one argument and avoidreturn type, but the original declaration has two arguments and athisreturn type. TypeScript rejects the new declaration as incompatible, see microsoft/TypeScript#6094.This problem is reported in #31. The newer version of TSTyche added checks for
.d.tsfiles. The change should unblock the PR.The types are correct and based on the current implementation:
vfs/lib/watcher.js
Lines 246 to 256 in 2882dd2
Solutions
The typings are correct. So I think using
@ts-expect-erroris ok solution.Another good solution can be found in #33.
Alternatively, it is possible to disable the additional TSTyche checks. But users with
"skipLibCheck": falseset will see the error.The error can be silenced by adding the original type declarations of
addListener()andremoveListener()as function overloads. But the typings would be incorrect, because methods ofVFSStatWatcherdo not take two arguments.Close #33