feature: alias modules in the worker #6167
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
Sometimes, users want to replace modules with other modules. This commonly happens inside a third party dependency itself. As an example, a user might have imported `node-fetch`, which will probably never work in workerd. You can use the alias config to replace any of these imports with a module of your choice. Let's say you make a `fetch-nolyfill.js` ```ts export default fetch; // all this does is export the standard fetch function` ``` You can then configure `wrangler.toml` like so: ```toml [alias] "node-fetch": "./fetch-nolyfill" ``` So any calls to `import fetch from 'node-fetch';` will simply use our nolyfilled version. You can also pass aliases in the cli (for both `dev` and `deploy`). Like: ```bash npx wrangler dev --alias node-fetch:./fetch-nolyfill ```
🦋 Changeset detectedLatest commit: 7799ced The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
A wrangler prerelease is available for testing. You can install this latest build in your project with: npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9713989200/npm-package-wrangler-6167You can reference the automatically updated head of this PR with: npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/6167/npm-package-wrangler-6167Or you can use npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9713989200/npm-package-wrangler-6167 dev path/to/script.jsAdditional artifacts:npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9713989200/npm-package-create-cloudflare-6167 --no-auto-updatenpm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9713989200/npm-package-cloudflare-kv-asset-handler-6167npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9713989200/npm-package-miniflare-6167npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9713989200/npm-package-cloudflare-pages-shared-6167npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9713989200/npm-package-cloudflare-vitest-pool-workers-6167Note that these links will no longer work once the GitHub Actions artifact expires.
Please ensure constraints are pinned, and |
Merged
This was referenced Jul 2, 2024
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.
Sometimes, users want to replace modules with other modules. This commonly happens inside a third party dependency itself. As an example, a user might have imported
node-fetch, which will probably never work in workerd. You can use the alias config to replace any of these imports with a module of your choice.Let's say you make a
fetch-nolyfill.jsYou can then configure
wrangler.tomllike so:So any calls to
import fetch from 'node-fetch';will simply use our nolyfilled version.You can also pass aliases in the cli (for both
devanddeploy). Like:Author has addressed the following