Skip to main content
Hot Module Replacement (HMR) updates modules in a running application without a full page reload, preserving application state.
HMR is enabled by default when using Bun’s full-stack development server.

import.meta.hot API Reference

Bun implements a client-side HMR API modeled after Vite’s import.meta.hot API. You can check for it with if (import.meta.hot), which tree-shakes it in production.
index.ts
This check is often unnecessary, since Bun dead-code-eliminates calls to all of the HMR APIs in production builds.
index.ts
For this dead-code elimination to work, Bun forces these APIs to be called without indirection. That means the following do not work:
index.ts
The HMR API is still a work in progress. Some features are missing. To disable HMR in Bun.serve, set the development option to { hmr: false }.

API Methods

import.meta.hot.accept()

The accept() method indicates that a module can be hot-replaced. Called without arguments, it means Bun can replace this module by re-evaluating the file. After a hot update, Bun automatically patches the module’s importers.
index.ts
This call creates a hot-reloading boundary for all of the files that index.ts imports. Whenever you save foo.ts or any of its dependencies, the update bubbles up to index.ts, which re-evaluates. Bun then patches the files that import index.ts to import the new version of getNegativeCount(). If you update only index.ts, Bun re-evaluates only that one file, and the counter in foo.ts is reused. Combine this with import.meta.hot.data to transfer state from the previous module to the new one.
When no modules call import.meta.hot.accept() (and there isn’t React Fast Refresh or a plugin calling it for you), the page reloads when the file updates. A console warning shows which files were invalidated. This warning is safe to ignore if it makes more sense to rely on full page reloads.

With callback

When passed a callback, import.meta.hot.accept works as it does in Vite. Instead of patching the importers of this module, it calls the callback with the new module.
index.ts
Prefer import.meta.hot.accept() without an argument; it usually makes your code clearer.

Accepting other modules

index.ts
Indicates that a dependency’s module can be accepted. When the dependency is updated, Bun calls the callback with the new module.

With multiple dependencies

index.ts
This variant accepts an array of dependencies. The callback receives the updated modules, and undefined for any that had errors.

import.meta.hot.data

import.meta.hot.data carries state from the previous version of a module to the new one across a hot replacement. Writing to import.meta.hot.data also marks the module as self-accepting (equivalent to calling import.meta.hot.accept()).
index.tsx
In production, Bun inlines data as {}, so you cannot use it as a state holder.
We recommend this pattern for stateful modules because Bun can minify {}.prop ??= value into value in production.

import.meta.hot.dispose()

Attaches an on-dispose callback. Bun calls it:
  • Just before the module is replaced with another copy (before the next is loaded)
  • After the module is detached (removing all imports to this module, see import.meta.hot.prune())
index.ts
Bun does not call this callback on route navigation or when the browser tab closes.
Returning a promise delays module replacement until the module is disposed. Bun calls all dispose callbacks in parallel.

import.meta.hot.prune()

Attaches an on-prune callback. Bun calls it when all imports to this module are removed, but the module was previously loaded. Use it to clean up resources that were created when the module was loaded. Unlike import.meta.hot.dispose(), it pairs better with accept and data for managing stateful resources. A full example managing a WebSocket:
index.ts
If you used dispose instead, the WebSocket would close and re-open on every hot update. Both versions of the code prevent page reloads when you update imported files.

import.meta.hot.on() and off()

Use on() and off() to listen for events from the HMR runtime. Event names carry a prefix so that plugins do not conflict with each other.
index.ts
When a file is replaced, Bun automatically removes all of its event listeners.

Built-in events

For compatibility with Vite, these events are also available with the vite:* prefix instead of bun:*.