Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
connect middleware
JavaScript
Branch: master
Failed to load latest commit information.
lib Fix maxAge option
test fix tests
.gitignore Initial commit
.jshintrc Tests added
.npmignore Initial commit
.travis.yml stop travis testing on 0.8
History.md Release 1.0.0
License Initial commit
Makefile Initial commit
Readme.md Merge branch 'pr/6'
index.js Initial implementation of gzip-static middleware
package.json Release 1.0.0

Readme.md

Build Status Dependency Status NPM version

connect-gzip-static

Middleware for connect: serves compressed files if they exist, falls through to connect-static if they don't, or if browser does not send 'Accept-Encoding' header.

You should use connect-gzip-static if your build process already creates gzipped files. If you want to gzip your data on the fly use built-in connect compress middleware. And if you want to gzip your files dynamically you may want to look up connect gzip.

Installation

  $ npm install connect-gzip-static

Options

gzip-static is meant to be a drop in replacement for connect static middleware. Use the same options as you would with connect static.

Usage

var gzipStatic = require('connect-gzip-static');
var oneDay = 86400000;

connect()
  .use(gzipStatic(__dirname + '/public'))

connect()
  .use(gzipStatic(__dirname + '/public', { maxAge: oneDay }))

How it works

gzip-static starts by locating all compressed files (ie. files with .gz extension) in root directory. All HTTP GET and HTTP HEAD requests with Accept-Encoding header set to gzip are checked against the list of compressed files and, if possible, fulfilled by returning the compressed versions. If compressed version is not found or if the request does not have an appropriate Accept-Encoding header, the request is processed in the same way as standard static middleware would handle it.

Debugging

This project uses debug module. To enable the debug log, just set the debug enviromental variable: DEBUG="connect:gzip-static"

License

MIT

Something went wrong with that request. Please try again.