fcache

package module

v2.1.2 Latest Latest Go to latest Published: Sep 29, 2020 License: MPL-2.0 Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/codemicro/fiber-cache

Links

Open Source Insights

Documentation ¶

Overview ¶

package fcache provides caching middleware for the Fiber web framework. The caching engine can be accessed through the Cache variable.

Index ¶

Constants
Variables
func New() func(*fiber.Ctx) error
func NewWithKey(key string) func(*fiber.Ctx) error
func NewWithTTL(key string, ttl time.Duration) func(*fiber.Ctx) error
type CacheEntry

Constants ¶

View Source

const (
	AutoGenerateKey = ""
	NoExpiration    = gc.NoExpiration
)

Variables ¶

View Source

var (
	Cache  *gc.Cache
	Config internalConfig
)

Functions ¶

func New ¶

func New() func(*fiber.Ctx) error

New returns a new instance of the caching middleware, with an automatically generated key and the default TTL.

func NewWithKey ¶

func NewWithKey(key string) func(*fiber.Ctx) error

NewWithKey returns a new instance of the caching middleware with the default TTL and the option to set your own cache key. If this is an empty string or AutoGenerateKey, a key will be automatically generated.

func NewWithTTL ¶

func NewWithTTL(key string, ttl time.Duration) func(*fiber.Ctx) error

NewWithTTL returns a new instance of the caching middleware with the option to define your own cache key and your own TTL. If the cache key you set is an empty string or AutoGenerateKey, a key will be automatically generated.

Types ¶

type CacheEntry ¶

type CacheEntry struct {
	Body        []byte
	StatusCode  int
	ContentType []byte
}

Source Files ¶

View all Source files

cache.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL