Buffer is not defined in React-vite

Question

Buffer is not defined after migrating from CRA(create react app)

Screenshot of error

"vite": "^2.7.12"

I try to add plugins, add define for Buffer, but it's not work.

const viteConfig = defineConfig({
/*    define: {
        "Buffer": {}
    },*/
    plugins: [reactRefresh(), react()],
    build: {
        rollupOptions: {
            input: {
                main: resolve('index.html'),
            },
        },
    },
    clearScreen: false
});

score 34 · Accepted Answer · edited May 20 '22 at 19:32

34

Install this library

@esbuild-plugins/node-globals-polyfill

and add this in your vite.config.js

export default defineConfig({
    // ...other config settings
    optimizeDeps: {
        esbuildOptions: {
            // Node.js global to browser globalThis
            define: {
                global: 'globalThis'
            },
            // Enable esbuild polyfill plugins
            plugins: [
                NodeGlobalsPolyfillPlugin({
                    buffer: true
                })
            ]
        }
    }
})

add this libary import to your vite.config.js

import { NodeGlobalsPolyfillPlugin } from '@esbuild-plugins/node-globals-polyfill'

edited May 20 '22 at 19:32

kelsny

23,009
3
19
48

answered Jan 15 '22 at 08:30

Николай Сычев

661
1
3
11

1

i'm using vite.config.ts, how can i stop typescript complaining about missing types for @esbuild-plugins/node-globals-polyfill? couldn't find a @types package. best i've managed is adding //ts-ignore, but not happy about it – kDar Jun 06 '22 at 11:05
I'm getting this error while running, Invalid define value (must be an entity name or valid JSON syntax) – Shehroz Khan Aug 02 '22 at 14:30
You saved my day, thanks for sharing! <3 – jdnichollsc Jun 26 '23 at 22:12

Felix Niemeyer · Answer 2 · 2023-01-13T17:34:15.680

Николай Сычев solution didn't work for me at first.

Instead, I succeeded by simply

installing buffer as a dev dependency yarn add buffer (use npm equivalent if you use npm)
and then adding it to the global scope in the index.html like this:

<html lang="en">
  <head>
    <script type="module">
      import { Buffer } from "buffer";
      window.Buffer = Buffer;
    </script>   
   ...

It also works for similar dependencies like process which you'd import in the index.html like this:

      import process from "process";
      window.process = process;

Update

For a different project I needed util, which required process. The above suggested method didn't suffice in that case.

Instead I found out that @esbuild-plugins (for vite dev) and rollup-plugin-polyfill-node (for vite build) would successfully provide all these nodejs packages.

Here is a full vite.config.ts that works for me:

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import { NodeGlobalsPolyfillPlugin } from '@esbuild-plugins/node-globals-polyfill'
import { NodeModulesPolyfillPlugin } from '@esbuild-plugins/node-modules-polyfill'
import rollupNodePolyFill from 'rollup-plugin-polyfill-node'

export default defineConfig({
  plugins: [vue()],
  base: '', 
  optimizeDeps: {
    esbuildOptions: {
      // Node.js global to browser globalThis
      define: {
        global: 'globalThis'
      },
      // Enable esbuild polyfill plugins
      plugins: [
        NodeGlobalsPolyfillPlugin({
          buffer: true, 
          process: true,
        }), 
        NodeModulesPolyfillPlugin() 
      ]
    }
  }, 
  build: {
    rollupOptions: {
      plugins: [
        rollupNodePolyFill()
      ]
    }
  }
})

Be careful to use rollup-plugin-polyfill-node which is an updated and maintained fork of rollup-plugin-node-polyfills.

Goutham J.M · Answer 3 · 2022-07-14T12:20:34.510

For me the above configuration did not work, I had to make changes in 3 files , in vite.config.ts , index.html and adding packages

1.Install Packages

yarn install process util buffer events
yarn add @esbuild-plugins/node-modules-polyfill

2.Update vite.config

import GlobalPolyFill from "@esbuild-plugins/node-globals-polyfill";
import react from "@vitejs/plugin-react";
import { resolve } from "path";
import { defineConfig } from "vite";

export default defineConfig({
    plugins: [react()],
    optimizeDeps: {
        esbuildOptions: {
            define: {
                global: "globalThis",
            },
            plugins: [
                GlobalPolyFill({
                    process: true,
                    buffer: true,
                }),
            ],
        },
    },
    resolve: {
        alias: {
            process: "process/browser",
            stream: "stream-browserify",
            zlib: "browserify-zlib",
            util: "util",
        },
    },
});

3.Update index.html

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <link rel="icon" type="image/svg+xml" href="/src/assets/images/favicon.svg" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Vite App</title>
  <script>
    window.global = window;
  </script>
  <script type="module">
    import process from "process";
    import EventEmitter from "events";
    import {Buffer} from "buffer";
    window.Buffer = Buffer;
    window.process = process;
    window.EventEmitter = EventEmitter;
  </script>
</head>

<body>
  <div id="root"></div>
  <script type="module" src="./src/index.js"></script>
</body>
</html>

There are some errors in which packages to use in the installation process and furthermore in their usage. — Manuel Bichler, Aug 22 '22 at 13:57
Is there a way to do this without importing in via script? I want to build it as a js file. — Bon Andre Opina, Nov 16 '22 at 14:15

score 1 · Answer 4 · answered Apr 20 '23 at 06:55

I'm using vite (4.2.1) and near-api-js (2.1.0). I stumbled upon this github thread, which contained these vite config settings

In order to make the near api work for my project, I added these settings to vite.config.ts:

import { defineConfig } from 'vite';
// added below polyfills to make near-api-js work with vite
// npm install --dev @esbuild-plugins/node-globals-polyfill
import { NodeGlobalsPolyfillPlugin } from '@esbuild-plugins/node-globals-polyfill';
// npm install --dev @esbuild-plugins/node-modules-polyfill
import { NodeModulesPolyfillPlugin } from '@esbuild-plugins/node-modules-polyfill';

fs.rmSync('dist', { recursive: true, force: true }); // v14.14.0

export default defineConfig({
  plugins: [],
  build: {
    commonjsOptions: {
      include: [],
    },
  },
  optimizeDeps: {
    disabled: false,
    esbuildOptions: {
      // Enable esbuild polyfill plugins
      plugins: [
        NodeGlobalsPolyfillPlugin({
          process: true,
          buffer: true,
        }),
        NodeModulesPolyfillPlugin(),
      ],
    },
  },
});

score 0 · Answer 5 · answered Dec 08 '22 at 01:35

0

Another approach is:

npm i -D rollup-plugin-polyfill-node

Then update vite.config.ts with the following:

import nodePolyfills from 'rollup-plugin-polyfill-node'

rollupOptions: {
  plugins: [
    // ...plugins
    nodePolyfills(),
  ],
  // ...rollupOptions
},

answered Dec 08 '22 at 01:35

David Hérault

35
1
6

This caused me to have other issues when trying to import items from react such as `useLayoutEffect` – Jack Feb 13 '23 at 17:28

score 0 · Answer 6 · answered Aug 23 '23 at 12:21

0

A solution that worked for me when migrating from CRA to Vite, is to use a browser library for buffer support (instead of relying on a Node polyfill):

npm i buffer

import {Buffer} from 'buffer';
...
Buffer.from(...

answered Aug 23 '23 at 12:21

Rob van der Leek

1,486
15
13

Buffer is not defined in React-vite

6 Answers6

Linked