brotli

README

brotli

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

Installation

The minimum requirement of Go is 1.18.

go get github.com/flamego/brotli

Getting started

package main

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

func main() {
	f := flamego.Classic()
	f.Use(brotli.Brotli())
	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 Brotli(options ...Options) flamego.Handler
• type Options

Functions

func Brotli

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

Brotli returns a Handler that adds brotli compression to all requests. Make sure to include the brotli 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 11 (from best speed to best compression). Default is 5.
	CompressionLevel int
}

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