#server.compress

• Type:

type Compress =
  | boolean
  | {
      filter?: (req: IncomingMessage, res: ServerResponse) => boolean;
    };

• Default: true

Configure whether to enable gzip compression for static assets served by the dev server or preview server.

#Disable compression

To disable the gzip compression, set compress to false:

export default {
  server: {
    compress: false,
  },
};

#Options

#filter

• Type: (req: IncomingMessage, res: ServerResponse) => boolean
• Default: undefined
• Version: >= v1.4.4

A function that determines whether a response should be compressed.

Returns true to compress the response, false to skip compression.

export default {
  server: {
    compress: {
      filter: (req) => {
        if (req.url?.includes('/foo')) {
          return false;
        }
        return true;
      },
    },
  },
};

#level

• Type: number
• Default:
  • Dev server: 1 (zlib.constants.Z_BEST_SPEED)
  • Preview server: 6 (zlib.constants.Z_DEFAULT_COMPRESSION)
• Version: >= v1.4.4

Used to set the level of zlib compression applied to responses. A higher level will result in better compression, but will take longer to complete; a lower level will result in less compression, but will be much faster. This value is an integer in the range of 0 (no compression) to 9 (maximum compression).

Rsbuild dev server uses zlib.constants.Z_BEST_SPEED as the default compression level, which provides the best compression performance. The preview server sets level to zlib.constants.Z_DEFAULT_COMPRESSION by default.

export default {
  server: {
    compress: {
      level: 6,
    },
  },
};