Explainer for manual commit #259
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
domenic
approved these changes
Mar 3, 2023
README.md
Outdated
|
|
||
| If a handler passed to `intercept()` rejects before `e.commit()` is called, then the navigation will be treated as canceled (both `committed` and `finished` promises will reject, and no url update will occur). If a handler passed to `intercept()` rejects after `e.commit()` is called, the behavior will match a rejected promise in immediate commit mode (i.e., the `committed` promise will fulfill, the `finished` promise will reject, and the url will update). | ||
|
|
||
| Because manual commit can be used to cancel the navigation before the url updates, it is only available when `e.cancelable` is true. |
There was a problem hiding this comment.
Suggested change
| Because manual commit can be used to cancel the navigation before the url updates, it is only available when `e.cancelable` is true. | |
| Because manual commit can be used to cancel the navigation before the URL updates, it is only available when `e.cancelable` is true. See [above](#restrictions-on-firing-canceling-and-responding) for details on when `e.cancelable` is set to false, and thus manual commit is not available. |
Also state what will happen if you try to use manual commit when e.cancelable is false. An exception, I assume.
There was a problem hiding this comment.
I haven't finalized that. My draft does a console warning (on the logic that it's better to invalidate the commit option, rather than invalidate the entire intercept). Is it ok to leave that ambiguous in the explainer (since we don't really enumerate every possible exception in other parts of the API)?
Co-authored-by: Domenic Denicola <[email protected]>
fabiancook
added a commit
to virtualstate/navigation
that referenced
this pull request
Mar 16, 2023
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.
No description provided.