esbuild-plugin-polyfill-node

ESBuild plugin to polyfill Node.js built-ins geared towards edge environments.

Installation

npm install esbuild-plugin-polyfill-node

Usage

import { build } from "esbuild";
import { nodePolyfills } from "esbuild-plugin-polyfill-node";

build({
    entryPoints: ["src/index.js"],
    bundle: true,
    outfile: "dist/bundle.js",
    plugins: [
        nodePolyfills({
            // Options (optional)
        }),
    ],
});

Options

• buffer: Whether to inject the Buffer global. Disable it to prevent code like if (typeof Buffer !== "undefined") from pulling in the (quite large) buffer-es6 polyfill. Default: true.
• process: Whether to inject the process global. Disable it to prevent process.env.NODE_ENV from pulling in the process-es6 polyfill. You can use the define option to replace process.env.NODE_ENV instead. Default: true.
• crypto: Whether to polyfill the crypto module. This is disabled by default because the crypto-browserify polyfill is quite large and you may want to think again before pulling it in. Using the Web Crypto API is usually a better idea. Default: false.
• fs: Whether to polyfill the fs module. This is disabled by default because the broserify-fs polyfill is quite large and you may want to think again before pulling it in. Default: false.

Provided polyfills

• _buffer_list as implemented in readable-stream
• _stream_passthrough as implemented in readable-stream
• _stream_readable as implemented in readable-stream
• _stream_transform as implemented in readable-stream
• _stream_writable as implemented in readable-stream
• assert as implemented in assert
• buffer as implemented in buffer-es6
• console as implemented in console-browserify
• crypto¹ as implemented in crypto-browserify
• domain as implemented in domain-browser
• events as implemented in events
• fs¹ as implemented in browserify-fs
• http as implemented in stream-http
• https as implemented in stream-http
• os as implemented in os
• path as implemented in path
• process as implemented in process-es6
• punycode as implemented in punycode
• querystring as implemented in querystring
• stream as implemented in stream
• string_decoder as implemented in string_decoder
• sys as implemented in util
• timers as implemented in timers-browserify
• tty as implemented in tty-browserify
• url as implemented in url
• util as implemented in util
• vm as implemented in vm-browserify
• zlib as implemented in browserify-zlib

¹ crypto and fs polyfills have to be explicitly enabled by passing crypto: true and fs: true to the plugin options. Otherwise, they will be replaced with empty stubs.

Shimmed globals

• global (aliased to globalThis)
• process¹ (imports the process module)
• Buffer¹ (imports the buffer module)
• __dirname (always "/")
• __filename (always "/index.js")

¹ process and Buffer shims can be disabled by passing process: false and buffer: false to the plugin options.

Empty polyfills

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

crypto and fs will also produce empty stubs unless explicitly enabled by passing crypto: true and fs: true to the plugin options.

Credits

• Fatih Aygün, under the MIT license
• Loosely based on rollup-plugin-polyfill-node