Node Polyfill Plugin#

By using the Node Polyfill plugin, Node core libs polyfills are automatically injected into the browser-side, allowing you to use these modules on the browser side with confidence.

Quick Start#

Used in Modern.js framework#

The Modern.js framework integrates the Builder's Node Polyfill plugin by default, so you don't need to manually install and register the plugin, just set the output.disableNodePolyfill config to false:

export default defineConfig({
  output: {
    disableNodePolyfill: false,
  },
});

Use via the Node API#

If you use the Builder's Node API, you need to manually install and register the esbuild plugin.

Install#

You can install the plugin with the following command:

npm add @modern-js/builder-plugin-node-polyfill -D

Register#

Register node polyfill plugin through the addPlugins method:

import { builderPluginNodePolyfill } from '@modern-js/builder-plugin-node-polyfill';

// add the plugin to the builder instance
builder.addPlugins([builderPluginNodePolyfill()]);

Node Polyfills#

Globals#

• Buffer
• process

When the above global variables are used directly in code, the corresponding polyfill will be injected.

const bufferData = Buffer.from('xxxx');

Modules#

• assert
• buffer
• console
• constants
• crypto
• domain
• events
• http
• https
• os
• path
• punycode
• process
• querystring
• stream
• _stream_duplex
• _stream_passthrough
• _stream_readable
• _stream_transform
• _stream_writable
• string_decoder
• sys
• timers
• tty
• url
• util
• vm
• zlib

When the above module is referenced in code via import / require syntax, the corresponding polyfill will be injected.

import { Buffer } from 'buffer';

const bufferData = Buffer.from('xxxx');

Fallbacks#

• child_process
• cluster
• dgram
• dns
• fs
• module
• net
• readline
• repl
• tls

Currently there is no polyfill for the above modules on the browser side, so when you import the above modules, it will automatically fallback to an empty object.

import fs from 'fs';

console.log(fs); // -> {}