Adds JSDocs for the lifecycle methods, and awaits the return of each. #736
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
jeffposnick
commented
Aug 10, 2017
| const returnedPromise = plugin.requestWillFetch({request}); | ||
| isInstance({returnedPromise}, Promise); | ||
| const returnedRequest = await returnedPromise; | ||
| const returnedRequest = await plugin.requestWillFetch({request}); |
There was a problem hiding this comment.
This logic is equivalent to what was there before; because I'm now using await, the return value from plugin.requestWillFetch() will always be a promise.
There was a problem hiding this comment.
Thanks for the note. The return value here always being a promise looks fine with your update.
addyosmani
approved these changes
Aug 10, 2017
gauntface
approved these changes
Aug 10, 2017
gauntface
pushed a commit
that referenced
this pull request
Aug 24, 2017
* Adds JSDocs for the lifecycle methods, and awaits the return of each. (#736) * Move towards using 'workbox' over 'workbox-cli'. (#744) * New library to support Range requests (#710) * WIP. * Still needs JSDocs. * Renaming, bug fixes, JSDoc. * Changed a few comments. * Updated tests to use new bundling infra, allowing us to remove private exports. * Modified a warning. * Rename cacheWillMatch to cachedResponseWillBeUsed (#748) * No longer register a fetch handler for each Router by default (#752) * No longer register a fetch handler for each Router by default. * Review feedback.
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.
R: @addyosmani @gauntface
Fixes #709, fixes #533
awaitis nice in that it doesn't require the expression to actually evaluate to a promise So bothawait Promise.resolve(true)andawait trueare both valid.Because of this, I just had to change the code that calls the lifecycle methods to consistently use
await, and the existing plugins that don't need to do anything asynchronous don't have to be updated.This opens the doors for new plugins that weren't previously able to return promises, like the Range request helper in #710.
I took the opportunity to add in formal JSDoc for the lifecycle methods, via
@callback, since that was a longstanding issue.