tree: 7cb435e147467e476f9063cbda3b6ac304e16ee6 [path history] [tgz]
  1. .gitignore
  2. .travis.yml
  3. CODE_OF_CONDUCT.md
  4. CONTRIBUTING.md
  5. gzip.go
  6. gzip_go18.go
  7. LICENSE
  8. README.md
metrics-server/vendor/github.com/NYTimes/gziphandler/README.md

Gzip Handler

This is a tiny Go package which wraps HTTP handlers to transparently gzip the response body, for clients which support it. Although it's usually simpler to leave that to a reverse proxy (like nginx or Varnish), this package is useful when that's undesirable.

Usage

Call GzipHandler with any handler (an object which implements the http.Handler interface), and it'll return a new handler which gzips the response. For example:

package main

import (
	"io"
	"net/http"
	"github.com/NYTimes/gziphandler"
)

func main() {
	withoutGz := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		w.Header().Set("Content-Type", "text/plain")
		io.WriteString(w, "Hello, World")
	})

	withGz := gziphandler.GzipHandler(withoutGz)

	http.Handle("/", withGz)
	http.ListenAndServe("0.0.0.0:8000", nil)
}

Documentation

The docs can be found at godoc.org, as usual.

License

Apache 2.0.