README
¶
gas/cache
Part of the Gas monorepo · Documentation · All modules
Key-value caching for the Gas framework, with two interchangeable backends: in-memory for development, Valkey (Redis-compatible) for production.
Implements gas.CacheProvider.
go get github.com/gasmod/gas/cache
gas.WithSingletonService[gas.CacheProvider](cachemem.New()),
Both backends need gas.ConfigProvider and gas.Logger.
| Package | Use case |
|---|---|
cache/memory |
Development, testing, single-instance deployments |
cache/valkey |
Production, multi-instance deployments |
cache/cachetest |
Recording mock of gas.CacheProvider |
Documentation
The full guide, with configuration, testing, and worked examples, is on the docs site. This README is deliberately a signpost: keeping a second copy here is how the docs drifted before.
- Guide: Cache expensive work
- API reference: pkg.go.dev/github.com/gasmod/gas/cache
- Contributing: CONTRIBUTING.md
License
Documentation
¶
Overview ¶
Package cache provides the caching service for the Gas ecosystem with in-memory and Valkey (Redis-compatible) backends. Concrete implementations live in the memory and valkey sub-packages.
See the module README for usage examples and design rationale.
SPDX-License-Identifier: MIT
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // ErrKeyNotFound is returned by Get when the requested key does not // exist or has expired. ErrKeyNotFound = errors.New("cache: key not found") // ErrClosed is returned when an operation is attempted on a closed // cache service. ErrClosed = errors.New("cache: service is closed") )
Sentinel errors returned by CacheProvider implementations.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files
Directories