Home > @lynx-js/rspeedy > Dev > hmr

Dev.hmr property#

Whether to enable Hot Module Replacement (HMR).

Signature:

hmr?: boolean | undefined;

Remarks#

Defaults to true.

By default, Rspeedy uses HMR as the preferred method to update modules. If HMR is disabled or cannot be used in certain scenarios, it will automatically fallback to Dev.liveReload.

To completely disable both HMR and live reload, set both dev.hmr and dev.liveReload to false. Then, no WebSocket requests will be made to the dev server on the page, and the page will not automatically refresh when file changes.

Example 1#

Disable HMR:

import { defineConfig } from '@lynx-js/rspeedy'

export default defineConfig({
  dev: {
    hmr: false,
  },
})

Example 2#

Disable both HMR and live reload:

import { defineConfig } from '@lynx-js/rspeedy'

export default defineConfig({
  dev: {
    hmr: false,
    liveReload: false,
  },
})