Usage

Compression options

@nuxt-modules/compression accepts several configuration options that are then passed to vite-plugin-compression.

export default defineNuxtConfig({
  buildModules: [
    ['@nuxt-modules/compression', {
      // options
    }]
  ]
})
}

Options

Defaults:

{
  disable: false,
  filter: /\.(js|mjs|json|css|html)$/i,
  verbose: true,
  threshold: 1025,
  compressionOptions: {},
  deleteOriginFile: false,
  success: () => {}
}

disable

• description - Whether to enable compression
• default - false

filter

• description - Filter files that do not need to be compressed
• default - /\.(js|mjs|json|css|html)$/i

verbose

• description - Log compressed files and their compression ratios
• default - true

threshold

• description - Minimum file size before compression is used
• default - 1025

compressionOptions

• description - Compression Options
• Partial<ZlibOptions> | Partial<BrotliOptions>

deleteOriginFile

• description - Delete the corresponding source file after compressing the file
• default - false

success

• description - success callback after completed
• default - () => {}