Don't use unknown for workbox-build method config #3037
Merged
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
tropicadri
approved these changes
Mar 2, 2022
Contributor
tropicadri
left a comment
tropicadri
left a comment
There was a problem hiding this comment.
Yay, I like this change.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Prior to this, the
getManifest(),generateSW(), andinjectManifest()methods ofworkbox-buildwere marked as taking in a configuration object with typeunknown. The idea was that prior to validating the configuration (which happens immediately), we should treat the object as potentially anything.Unfortunately, this leads to a bad experience in our TSDocs, and likely for users who rely on TypeScript code completion.
Additionally, if you actually attempt to pass in anything other than the support options, the validation step should immediately throw, so passing in just anything didn't actually "work." Because of this, I consider adding in explicit types for the config to be a bug fix rather than a breaking change, as we never should have had
unknownto begin with.