Clarify series cancellation behavior - #2084
Open
ryanchou1994 wants to merge 1 commit into
Open
ryanchou1994 wants to merge 1 commit into
ryanchou1994 wants to merge 1 commit into
Conversation
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.
callback(false)is an intentional cancellation signal, but theseriesAPI documentation only described error and success completion. That made cancellation look like a silent failure when the final callback did not run.Clarify the common-pitfalls section and the
seriesAPI docs so they state that:callback(false)cancels the flow, skips the remaining work, and does not invoke the final callback.callback(null)reports success and allows the flow to continue.The generated v3 documentation is updated from the same sources.
npm testpasses with 690 tests on macOS and Linux.Closes #2035