Registry / devops / esbuild-reloader

esbuild-reloader

JSON →
library0.4.1jsnpmunverified

An esbuild plugin that automatically reloads the browser page whenever a new build completes in watch mode. Version 0.4.1 is the latest stable release. It works by injecting a WebSocket listener into the bundle and triggering a page reload on rebuild. Unlike general-purpose live reloaders, this plugin is tightly integrated with esbuild's watch mode and does nothing during regular builds. It supports configurable host, port, reconnect timeout, and retry settings. Released on an as-needed cadence with no recent updates.

devops
npm install esbuild-reloader
github ↗package ↗
INSTALL
IMPORT
SIG · ESBUILD-RELOADER
E
esbuild-reloader
devopsjavascriptv0.4.1
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.

default
✓ import reloader from 'esbuild-reloader'
✗ import { reloader } from 'esbuild-reloader'
Package exports a default function only. Named import fails.
default
✓ const reloader = require('esbuild-reloader')
✗ const { reloader } = require('esbuild-reloader')
In CJS, assign the default export directly, not through destructuring.
EsbuildReloaderOptions
✓ import type { EsbuildReloaderOptions } from 'esbuild-reloader'
TypeScript users can import the options interface by name. This is the only named export.

Sets up esbuild watch mode with esbuild-reloader plugin to auto-reload on rebuild.

import esbuild from 'esbuild'; import reloader from 'esbuild-reloader'; await esbuild.build({ entryPoints: ['src/index.js'], outfile: 'dist/bundle.js', bundle: true, watch: true, plugins: [ reloader({ host: '127.0.0.1', port: 8001, reconnectTimeout: 5000, retries: 10 }) ] });
Debug
Known issues
gotchaPlugin only works when watch mode is enabled; does nothing in regular builds.
fix
Ensure the esbuild build config has `watch: true`.
affects: >=0.1
gotchaInjecting the WebSocket listener may cause browser CSP issues if Content-Security-Policy blocks inline scripts or websocket connections.
fix
Adjust CSP to allow 'ws://' connections to the specified host/port.
affects: >=0.1
deprecatedThe package lacks explicit support for esbuild v0.18+ where watch API changed. May still work but not officially tested.
fix
Prefer esbuild's built-in serve mode or use a more actively maintained reload plugin.
affects: >=0.18
Errors
Common errors & fixes
Error: [plugin: esbuild-reloader] Must be used with watch mode
esbuild.build() called without `watch: true`.
fix
Add `watch: true` to your esbuild build options.
TypeError: esbuild_reloader_1.default is not a function
Using incorrect import style (named import instead of default).
fix
Use `import reloader from 'esbuild-reloader'` or `const reloader = require('esbuild-reloader')`.
Upgrade
Version history
0.4.1latest on npm
Audit
Dependencies
esbuildrequiredpeer dependency; the plugin hooks into esbuild's watch mode
Agent activity
2 hits · last 30 days
node
2
Resources
githubhttps://github.com/YurySolovyov/esbuild-reloader ↗
packagehttps://www.npmjs.com/package/esbuild-reloader ↗
esbuild-reloader — npm install esbuild-reloader · libregistry