server.middlewareMode#

• Type: boolean
• Default: false
• Version: >= 1.2.12

Whether to create Rsbuild's server in middleware mode, which is useful for integrating with other servers.

When this option is enabled, Rsbuild will not create an HTTP server. This option is usually only needed when using the JavaScript API of Rsbuild.

Example#

A typical use case is that you want to integrate the Rsbuild server into a custom server. You can achieve this by combining server.middlewareMode and rsbuild.createDevServer.

import { createRsbuild } from '@rsbuild/core';
import express from 'express';

async function startDevServer() {
  // Initialize Rsbuild in middleware mode
  const rsbuild = await createRsbuild({
    rsbuildConfig: {
      server: {
        middlewareMode: true,
      },
    },
  });

  const app = express();

  // Create Rsbuild dev server instance
  const rsbuildServer = await rsbuild.createDevServer();

  // Apply Rsbuild's built-in middlewares
  app.use(rsbuildServer.middlewares);
}

See Integrate with custom server for more details.