Improve typing of teardown methods #3003
Merged
Conversation
This file contains 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
This helps with the @typescript-eslint/no-misused-promises ESLint rule.
The returned method always returns Promise<void>. The teardown function itself may or may not return a promise. Support both to help with the @typescript-eslint/no-misused-promises ESLint rule.
sindresorhus
reviewed
Apr 5, 2022
| @@ -41,7 +41,7 @@ export namespace SharedWorker { | |||
| readonly file: string; | |||
| publish: (data: Data) => PublishedMessage<Data>; | |||
| subscribe: () => AsyncIterableIterator<ReceivedMessage<Data>>; | |||
| teardown: <TeardownFn extends () => void> (fn: TeardownFn) => TeardownFn; | |||
| teardown: (fn: (() => Promise<void>) | (() => void)) => () => Promise<void>; | |||
There was a problem hiding this comment.
Suggested change
| teardown: (fn: (() => Promise<void>) | (() => void)) => () => Promise<void>; | |
| teardown: (fn: (() => Promise<void> | void) => () => Promise<void>; |
?
There was a problem hiding this comment.
Would that be fine or would void "nullify" Promise<void>? Or would it be clearer to have overloads?
There was a problem hiding this comment.
Hmm: microsoft/TypeScript#43921
I guess what you have is fine.
There was a problem hiding this comment.
I don't really know if overloads will make any difference.
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.
The teardown functions may or may not return a promise. Support both to help with the @typescript-eslint/no-misused-promises ESLint rule.