JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4495
  • Score
    100M100P100Q122353F
  • License MIT

Runs gzip and brotli compression on static assets during Nuxt build

Package Exports

  • nuxt-compress

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (nuxt-compress) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

nuxt-compress

License: MIT npm download count Dependency status for latest release Vulnerability count from Snyk

A simple static asset compression module for Nuxt that runs Gzip and Brotli compression during the build process.

This is significantly more efficient than compressing files on the fly, especially for Brotli compression, which sacrifices CPU time for greater compression.

For compression during runtime, see the compressor entry in the Nuxt configuration docs

Getting Started

  1. Install the module

    npm install nuxt-compress

    OR

    yarn add nuxt-compress
  2. Add the module to your nuxt.config.js (Nuxt < v2.9)

    module.exports = {
      modules: ["nuxt-compress"]
    };

    OR (recommended way, N.B.: this feature is only available since Nuxt v2.9)

    module.exports = {
      buildModules: ["nuxt-compress"]
    };

Configuration

This module provides a simple interface to include brotli-webpack-plugin and compression-webpack-plugin and uses the same configuration options, which can be supplied as a second argument to the entry in "modules" in your nuxt.config.js, or as a distinct entry with the key "nuxt-compress". See the Nuxt Modules guide for more information.

For example:

module.exports = {
  modules: [
    [
      "nuxt-compress",
      {
        gzip: {
          cache: true
        },
        brotli: {
          threshold: 10240
        }
      }
    ]
  ]
};

OR

module.exports = {
  modules: ["nuxt-compress"],
  "nuxt-compress": {
    gzip: {
      cache: true
    },
    brotli: {
      threshold: 10240
    }
  }
};