\n\n## When to use\n\nNormally, we don't need to use Node builtin modules on the browser side. However, it is possible to use some Node builtin modules when the code will run on both the Node side and the browser side, and this plugin provides browser versions of polyfills for these Node builtin modules.\n\nBy using the Node Polyfill plugin, polyfills for Node builtin modules are automatically injected into the browser-side, allowing you to use these modules on the browser side with confidence.\n\n## Usage\n\nInstall:\n\n```bash\nnpm add @rsbuild/plugin-node-polyfill -D\n```\n\nAdd plugin to your `rsbuild.config.ts`:\n\n```ts\n// rsbuild.config.ts\nimport { pluginNodePolyfill } from \"@rsbuild/plugin-node-polyfill\";\n\nexport default {\n plugins: [pluginNodePolyfill()],\n};\n```\n\n## Node Polyfills\n\n### Globals\n\n- `Buffer`\n- `process`\n\nWhen you use the above global variables in your code, the corresponding polyfill will be automatically injected.\n\nFor instance, the following code would inject the `Buffer` polyfill:\n\n```ts\nconst bufferData = Buffer.from(\"abc\");\n```\n\nYou can disable this behavior through the `globals` option of the plugin:\n\n```ts\npluginNodePolyfill({\n globals: {\n Buffer: false,\n process: false,\n },\n});\n```\n\n### Modules\n\n- `assert`\n- `buffer`\n- `console`\n- `constants`\n- `crypto`\n- `domain`\n- `events`\n- `http`\n- `https`\n- `os`\n- `path`\n- `punycode`\n- `process`\n- `querystring`\n- `stream`\n- `_stream_duplex`\n- `_stream_passthrough`\n- `_stream_readable`\n- `_stream_transform`\n- `_stream_writable`\n- `string_decoder`\n- `sys`\n- `timers`\n- `tty`\n- `url`\n- `util`\n- `vm`\n- `zlib`\n\nWhen the above module is referenced in code via import / require syntax, the corresponding polyfill will be injected.\n\n```ts\nimport { Buffer } from \"buffer\";\n\nconst bufferData = Buffer.from(\"abc\");\n```\n\n### Fallbacks\n\n- `child_process`\n- `cluster`\n- `dgram`\n- `dns`\n- `fs`\n- `module`\n- `net`\n- `readline`\n- `repl`\n- `tls`\n- `v8`\n\nCurrently 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.\n\n```ts\nimport fs from \"fs\";\n\nconsole.log(fs); // -> {}\n```\n\n## Options\n\n### globals\n\nUsed to specify whether to inject polyfills for global variables.\n\n- **Type:**\n\n```ts\ntype GlobalsOption = {\n /**\n * Whether to inject the polyfill for direct identifier usage,\n * e.g. `Buffer` or `process` (bare usage without any object prefix).\n * @default true\n */\n bare?: boolean;\n /**\n * Whether to inject the polyfill for usage via the `global` object,\n * e.g. `global.Buffer` or `global.process`.\n * @default false\n */\n global?: boolean;\n /**\n * Whether to inject the polyfill for usage via the `globalThis` object,\n * e.g. `globalThis.Buffer` or `globalThis.process`.\n * @default false\n */\n globalThis?: boolean;\n};\n\ntype Globals = {\n process?: boolean | GlobalsOption;\n Buffer?: boolean | GlobalsOption;\n};\n```\n\n- **Default:**\n\n```ts\nconst defaultGlobals = {\n Buffer: {\n bare: true,\n global: false,\n globalThis: false,\n },\n process: {\n bare: true,\n global: false,\n globalThis: false,\n },\n};\n```\n\n### protocolImports\n\nWhether to polyfill Node.js builtin modules starting with `node:`.\n\n```ts\nconst defaultGlobals = {\n Buffer: true,\n process: true,\n};\n```\n\n### protocolImports\n\nWhether to polyfill Node.js builtin modules starting with `node:`.\n\n- **Type:** `boolean`\n- **Default:** `true`\n\nFor example, if you disable `protocolImports`, modules such as `node:path`, `node:http`, etc. will not be polyfilled.\n\n```ts\npluginNodePolyfill({\n protocolImports: false,\n});\n```\n\n### include\n\nSpecify an array of modules for which polyfills should be injected. If this option is set, only the specified modules will be polyfilled. `include` is mutually exclusive with [`exclude`](#exclude).\n\n- **Type:** `string[]`\n- **Default:** `undefined`\n\n```ts\npluginNodePolyfill({\n include: [\"buffer\", \"crypto\"], // Only \"buffer\" and \"crypto\" modules will be polyfilled.\n});\n```\n\n### exclude\n\nSpecify an array of modules for which polyfills should not be injected from the default. If this option is set, the specified modules will be excluded from polyfilled. `exclude` is mutually exclusive with [`include`](#include).\n\n- **Type:** `string[]`\n- **Default:** `undefined`\n\n```ts\npluginNodePolyfill({\n exclude: [\"http\", \"https\"], // All modules except \"http\" and \"https\" will be polyfilled.\n});\n```\n\n### overrides\n\nOverride the default polyfills for specific modules.\n\n- **Type:** `Record`\n- **Default:** `{}`\n\n```ts\npluginNodePolyfill({\n overrides: {\n fs: \"memfs\",\n },\n});\n```\n\n### force\n\nBy default, the plugin only polyfills the browser-side code. If you want to polyfill the server-side code as well (when `output.target` is `node`), you can set the `force` option to `true`.\n\n- **Type:** `boolean`\n- **Default:** `false`\n\n```ts\npluginNodePolyfill({\n force: true,\n});\n```\n\n## Exported variables\n\n- `builtinMappingResolved`: A map of Node.js builtin modules to their resolved corresponding polyfills modules.\n- `resolvedPolyfillToModules`: A map of resolved polyfill modules to the polyfill modules before resolving.\n\n## License\n\n[MIT](./LICENSE).","users":{}}
![\"npm](\"https://img.shields.io/npm/v/@rsbuild/plugin-node-polyfill?style=flat-square&colorA=564341&colorB=EDED91\")
\n \n ![\"license\"](\"https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91\"){kind=icon}
\n ![\"downloads\"](\"https://img.shields.io/npm/dm/@rsbuild/plugin-node-polyfill.svg?style=flat-square&colorA=564341&colorB=EDED91\")
\n