Add support for using third party worker-loader plugins #10219
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
mourner
reviewed
Dec 16, 2020
src/index.js
Outdated
| * @returns {Object|null} a Class object an instance of which exposes the `Worker` interface. | ||
| * @example | ||
| * import mapboxgl from 'mapbox-gl/mapbox-gl-csp.js' | ||
| * import MapboxGLWorker from 'mapbox-gl/mapbox-gl-csp-worker.js' |
There was a problem hiding this comment.
Should we explicitly use WebPack's worker loader here as an example?
mourner
approved these changes
Dec 17, 2020
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.
This PR adds support for using WebWorker loader's from external build-systems such as Webpack or rollup.
Both their worker-loader plugins expose the bundled webworker code as a class, that when instantiated exposes the same interface as a raw Worker, i.e it has the
postMessageandonMessagehooks. This means we can seamlessly swap out the global worker with this custom class to allow users to use these toolsPR for extended documentation is here:
https://github.com/mapbox/mapbox-gl-js-docs/pull/461
Launch Checklist
mapbox-gl-jschangelog:<changelog>Add support for bundling the WebWorker with external module bundlers.</changelog>