|
| 1 | +import { Steps, SourceCode } from '@theme'; |
| 2 | +import { PackageManagerTabs } from '@theme'; |
| 3 | + |
| 4 | +# Node Polyfill |
| 5 | + |
| 6 | +:::tip About Node Polyfill |
| 7 | +Normally, we don't need to use Node libs on the browser side. However, it is possible to use some Node libs when the code will run on both the Node side and the browser side, and Node Polyfill provides browser versions of polyfills for these Node libs. |
| 8 | +::: |
| 9 | + |
| 10 | +By using [@rsbuild/plugin-node-polyfill](https://github.com/rspack-contrib/rsbuild-plugin-node-polyfill), Node core libs polyfills are automatically injected into the browser-side, allowing you to use these modules on the browser side with confidence. |
| 11 | + |
| 12 | +## Getting Start |
| 13 | + |
| 14 | +<Steps> |
| 15 | + |
| 16 | +### Install plugin |
| 17 | + |
| 18 | +Rslib uses [@rsbuild/plugin-node-polyfill](https://github.com/rspack-contrib/rsbuild-plugin-node-polyfill) to provide the Node Polyfill feature. |
| 19 | + |
| 20 | +<PackageManagerTabs command="@rsbuild/plugin-node-polyfill -D" /> |
| 21 | + |
| 22 | +### Register plugin |
| 23 | + |
| 24 | +Add the plugin into the plugins field. |
| 25 | + |
| 26 | +```ts |
| 27 | +import { defineConfig } from '@rslib/core'; |
| 28 | +import { pluginNodePolyfill } from '@rsbuild/plugin-node-polyfill'; |
| 29 | + |
| 30 | +export default defineConfig({ |
| 31 | + lib: [{ format: 'esm' }], |
| 32 | + plugins: [pluginNodePolyfill()], |
| 33 | +}); |
| 34 | +``` |
| 35 | + |
| 36 | +### Setup |
| 37 | + |
| 38 | +- For projects with `bundle` enabled, the Node Polyfill will be injected and included in the output. |
| 39 | +- For projects with `bundle` disabled, polyfills are not injected into the output by default. To avoid inlining the polyfill in every module. The modules are externalized and need to be added to dependencies manually, follow these steps: |
| 40 | + |
| 41 | + 1. Configure `output.external` with `resolvedPolyfillToModules`, which you can import from [@rsbuild/plugin-node-polyfill](https://github.com/rspack-contrib/rsbuild-plugin-node-polyfill). This will externalize the polyfill modules to the installed polyfill dependencies. |
| 42 | + 2. Install used polyfill modules as dependencies. |
| 43 | + |
| 44 | + With the following steps, every usage of the polyfill module will be replaced by the corresponding module in the `externals` field. Checkout the <SourceCode href="https://github.com/web-infra-dev/rslib/blob/main/tests/integration/node-polyfill/bundle-false/rslib.config.ts" /> of the example for more details. |
| 45 | + |
| 46 | +</Steps> |
| 47 | + |
| 48 | +### |
| 49 | + |
| 50 | +## Configurations |
| 51 | + |
| 52 | +Check out the documentation of [@rsbuild/plugin-node-polyfill](https://github.com/rspack-contrib/rsbuild-plugin-node-polyfill), all the configurations are applicable for Rslib. |
0 commit comments