gzip

README

gzip

Package gzip is a middleware that provides gzip compression to responses for Flamego.

Installation

The minimum requirement of Go is 1.18.

go get github.com/flamego/gzip

Getting started

package main

import (
	"github.com/flamego/flamego"
	"github.com/flamego/gzip"
)

func main() {
	f := flamego.Classic()
	f.Use(gzip.Gzip())
	f.Get("/", func() string {
		return "ok"
	})
	f.Run()
}

Getting help

• Read documentation and examples.
• Please file an issue or start a discussion on the flamego/flamego repository.

License

This project is under the MIT License. See the LICENSE file for the full license text.

Documentation

Index

• func Gzip(options ...Options) flamego.Handler
• type Options

Functions

func Gzip

func Gzip(options ...Options) flamego.Handler

Gzip returns a Handler that adds gzip compression to all requests. Make sure to include the gzip middleware above other middleware that alter the response body (like the render middleware).

Types

type Options

type Options struct {
	// CompressionLevel indicates the compression level, possible values are between
	// 0 to 9 (from no compression to best compression). Default is 4.
	CompressionLevel int
}

Options represents a struct for specifying configuration options for the gzip middleware.