Repository navigation
Make Scheduler.postTask generic over the callback result - #2583
Open
Martin Ferret (MartinFerret) wants to merge 1 commit into
Open
Martin Ferret (MartinFerret) wants to merge 1 commit into
Martin Ferret (MartinFerret) wants to merge 1 commit into
Conversation
Contributor
|
Thanks for the PR! This section of the codebase is owned by Kagami Sascha Rosylight (@saschanaz) - if they write a comment saying "LGTM" then it will be merged. |
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.
Fixes #2084
Scheduler.postTask()currently returnsPromise<any>and its callback is typedSchedulerPostTaskCallbackwith signature(): any, so the type of the callback's result is lost.This makes both generic, through
inputfiles/overridingTypes.jsonconly:The callback returns
T | PromiseLike<T>becausepostTask()resolves its promise with the callback's result, so an async callback is unwrapped:postTask(async () => "done")givesPromise<string>. This follows the existingTransformerFlushCallbackpattern.Tdefaults toany, likestructuredClone<T = any>, so references toSchedulerPostTaskCallbackwithout a type argument keep compiling.Behavior change: the result type is now inferred from the callback instead of
any. The code that relied on theanyresult (for example assigningawait scheduler.postTask(() => 42)to astring) now gets a type error. That is the only change.Added
unittests/files/schedulerPostTask.tswhich checks the result types exactly and fails with the override reverted.Hope this is ok! 😊