Registry / devops / esbuild-plugin-brotli

esbuild-plugin-brotli

JSON →
library0.2.0jsnpmunverified

esbuild-plugin-brotli (v0.2.0) is a plugin for esbuild that compresses output files using Brotli algorithm during the build process. It integrates with esbuild's onEnd hook to generate .br files alongside original assets. Compared to generic compression plugins, it focuses exclusively on Brotli, offering simpler configuration. The plugin wraps Node.js zlib's brotliCompressSync. Compatible with esbuild >=0.8.0. No frequent releases; last update on npm was 2022. Active status unclear.

devops
npm install esbuild-plugin-brotli
github ↗package ↗
INSTALL
IMPORT
SIG · ESBUILD-PLUGIN-BRO
E
esbuild-plugin-brotli
devopsjavascriptv0.2.0
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

brotliPlugin
✓ import { brotliPlugin } from 'esbuild-plugin-brotli'
✗ const brotliPlugin = require('esbuild-plugin-brotli')
Package is ESM-only; require() will fail. Use import.
brotliPlugin
✓ const { brotliPlugin } = await import('esbuild-plugin-brotli')
✗ const brotliPlugin = require('esbuild-plugin-brotli')
In CommonJS, use dynamic import()
default
✓ import brotliPlugin from 'esbuild-plugin-brotli'
✗ const brotliPlugin = require('esbuild-plugin-brotli').default
Default export also available; named export is preferred.

Shows basic usage of esbuild-plugin-brotli to compress output during esbuild build.

import { build } from 'esbuild'; import { brotliPlugin } from 'esbuild-plugin-brotli'; await build({ entryPoints: ['src/index.js'], outdir: 'dist', bundle: true, plugins: [brotliPlugin()], }); // After build, dist/index.js and dist/index.js.br are created.
Debug
Known issues
gotchaPlugin uses synchronous compression; may block event loop for large files.
fix
Use async compression plugin or limit file sizes.
affects: >=0.0.0
deprecatedesbuild's built-in compression via 'assetNames' may be preferred.
fix
Consider using esbuild's native Brotli compression if using esbuild >=0.19.0.
affects: >=0.0.0
gotchaPlugin only compresses files with extensions .js, .css, .html, .json by default.
fix
Provide custom 'filter' option to include other extensions.
affects: >=0.0.0
Errors
Common errors & fixes
Error: Cannot find module 'esbuild-plugin-brotli'
Package not installed or not in node_modules
fix
Run npm install esbuild-plugin-brotli
TypeError: brotliPlugin is not a function
Incorrect import; likely using default import without parentheses
fix
Use import { brotliPlugin } from 'esbuild-plugin-brotli'
Error: esbuild-plugin-brotli requires esbuild. Please install it.
Missing esbuild peer dependency
fix
Install esbuild: npm install esbuild
Upgrade
Version history
0.2.0latest on npm
Audit
Dependencies
esbuildrequiredpeer dependency; plugin is designed to work as an esbuild plugin
Agent activity
2 hits · last 30 days
node
2
Resources
githubhttps://github.com/linux-china/esbuild-plugin-brotli ↗
packagehttps://www.npmjs.com/package/esbuild-plugin-brotli ↗
esbuild-plugin-brotli — npm install esbuild-plugin-brotli · libregistry