Rspeedy logoRspeedy logo
Rspeedy
Guide
APIs
Blog
Contribute
Guide
APIs
Blog
Contribute

Home > @lynx-js/rspeedy > Server > compress

Server.compress property

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

Default: true

See Rsbuild - server.compress for details.

Signature:

compress?: boolean | CompressOptions | undefined;

Example 1

To disable the gzip compression, set compress to false:

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

Example 2

Compress if it starts with /foo

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

Example 3

set level of zlib compression

export default {
  server: {
    compress: {
      level: 6,
    },
  },
}
Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.