cacheman

README

Cacheman

A useful gas that used to manage the Cache-Control header for the web applications built using Air.

Installation

Open your terminal and execute

$ go get github.com/air-gases/cacheman

done.

The only requirement is the Go, at least v1.13.

Usage

Create a file named main.go

package main

import (
	"github.com/air-gases/cacheman"
	"github.com/aofei/air"
)

func main() {
	a := air.Default
	a.DebugMode = true
	a.GET("/", func(req *air.Request, res *air.Response) error {
		return res.WriteString("This message will last for an hour.")
	}, cacheman.Gas(cacheman.GasConfig{
		MaxAge:  3600,
		SMaxAge: -1,
	}))
	a.Serve()
}

and run it

$ go run main.go

then visit http://localhost:8080.

Community

If you want to discuss Cacheman, or ask questions about it, simply post questions or ideas here.

Contributing

If you want to help build Cacheman, simply follow this to send pull requests here.

License

This project is licensed under the MIT License.

License can be found here.

Documentation

Index

• func Gas(gc GasConfig) air.Gas
• type GasConfig

Functions

func Gas

func Gas(gc GasConfig) air.Gas

Gas returns an `air.Gas` that is used to manage the Cache-Control header based on the gc.

Types

type GasConfig

type GasConfig struct {
	MustRevalidate  bool
	NoCache         bool
	NoStore         bool
	NoTransform     bool
	Public          bool
	Private         bool
	ProxyRevalidate bool
	MaxAge          int
	SMaxAge         int

	Skippable func(*air.Request, *air.Response) bool
}

GasConfig is a set of configurations for the `Gas`.