Remove simple alias for wait -> settled.
#317
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
Turbo87
requested changes
Feb 10, 2018
| @deprecated | ||
| @returns {Promise<void>} resolves when settled | ||
| */ | ||
| export default function settled() { |
There was a problem hiding this comment.
I think this should be called wait(), not settled()
| @returns {Promise<void>} resolves when settled | ||
| */ | ||
| export default function settled() { | ||
| let options = arguments[0]; |
There was a problem hiding this comment.
we should use function wait(options = {}) { instead
There was a problem hiding this comment.
Hmm, actually its a tad different. The old 0.6.x wait code avoided errors when something like a number was passed in, if I use default arguments here it will only correct for undefined specifically...
There was a problem hiding this comment.
sure, the logic to handle non-objects would likely still need to exists, but I think putting options = {} in would still be good for documentation purposes
rwjblue
force-pushed
the
alternative-suggestion
branch
from
a58fbd9
to
b96d19c
Compare
The original goal of `settled` was to "rebrand" `wait` as `settled` without the 'baggage" (since `wait` had some legacy APIs that should not exist in `settled`). Unfortunately, the code refactoring that I had originally done that allowed them to be shared resulted in introducing bugs like those reported. This commit completely severs the implementation of `wait` from that of `settled`, by leveraging the (IMHO very nice) layers of abstraction that we have created since the original extraction. Implementing `wait` with `waitUntil` and `getSettledState` makes this quite trivial now. tldr of changes: * `isSettled` no longer has to support the legacy `wait` contract (this was undocumented private behavior _only_ kept around to support the old semantics of `wait`) * `wait` is implemented as its own `waitUntil` with the same semantics it has had since the 0.6.x series
rwjblue
force-pushed
the
alternative-suggestion
branch
from
b96d19c
to
8bb08cc
Compare
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 original goal of
settledwas to "rebrand"waitassettledwithout the 'baggage" (sincewaithad some legacy APIs that should not exist insettled). Unfortunately, the code refactoring that I had originally done that allowed them to be shared resulted in introducing bugs like those reported in #283.This commit completely severs the implementation of
waitfrom that ofsettled, by leveraging the (IMHO very nice) layers of abstraction that we have created since the original extraction. ImplementingwaitwithwaitUntilandgetSettledStatemakes this quite trivial now.tldr of changes:
isSettledno longer has to support the legacywaitcontract (this was undocumented private behavior only kept around to support the old semantics ofwait)waitis implemented as its ownwaitUntilwith the same semantics it has had since the 0.6.x seriesFixes #300
Fixes #283
Closes #303