vite-plugin-ngmi-polyfill

0.0.2 verified Mon Apr 27 auth: no javascript

Vite plugin that polyfills Node.js built-in globals (e.g., process, Buffer) and modules (e.g., events, stream) for browser environments. Current stable version is 0.0.2, released in 2022. Wraps @esbuild-plugins/node-globals-polyfill and @esbuild-plugins/node-modules-polyfill into a single Vite plugin. Useful for projects like web3 that depend on Node.js polyfills. Requires Vite ^3. Ships TypeScript types.

Common errors

error Cannot find module 'vite' ↓

cause Missing Vite as peer dependency.

fix

Run 'npm install vite' or 'yarn add vite'.

Warnings

gotcha NgmiPolyfill does not polyfill all Node.js built-ins; only those provided by @esbuild-plugins/node-globals-polyfill and @esbuild-plugins/node-modules-polyfill. ↓

fix Review the included packages list and manually add additional polyfills if needed.

gotcha The plugin may break if used with Vite versions older than 3, as it requires Vite ^3. ↓

fix Upgrade Vite to version 3 or later.

Install

npm install vite-plugin-ngmi-polyfill

yarn add vite-plugin-ngmi-polyfill

pnpm add vite-plugin-ngmi-polyfill

Imports

NgmiPolyfill
wrong
```
const NgmiPolyfill = require('vite-plugin-ngmi-polyfill')
```
correct
```
import { NgmiPolyfill } from 'vite-plugin-ngmi-polyfill'
```
Default export does not exist; must use named import. CommonJS require will not work as the package is ESM-only.

Quickstart

Minimal Vite configuration using NgmiPolyfill plugin to polyfill Node.js built-ins for browser builds.

import { defineConfig } from 'vite';
import { NgmiPolyfill } from 'vite-plugin-ngmi-polyfill';

export default defineConfig({
  plugins: [NgmiPolyfill()],
});