Node Polyfill#

By using @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.

Getting Started#

Install plugin#

Rslib uses @rsbuild/plugin-node-polyfill to provide the Node Polyfill feature.

npm @rsbuild/plugin-node-polyfill -D

Register plugin#

Then add the plugin into the plugins field.

import { defineConfig } from '@rslib/core';
import { pluginNodePolyfill } from '@rsbuild/plugin-node-polyfill';

export default defineConfig({
  lib: [{ format: 'esm' }],
  plugins: [pluginNodePolyfill()],
});

Setup#

• For projects with bundle enabled, the Node Polyfill will be injected and included in the output.

• 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:

  1. Configure output.external with resolvedPolyfillToModules, which you can import from @rsbuild/plugin-node-polyfill. This will externalize the polyfill modules to the installed polyfill dependencies.
  2. Install used polyfill modules as dependencies.

  With the following steps, every usage of the polyfill module will be replaced by the corresponding module in the externals field. Checkout the

  Source
  of the example for more details.

#

Configurations#

Check out the documentation of @rsbuild/plugin-node-polyfill, all the configurations are applicable for Rslib.