golazy.dev
–
golazy.dev
/
lazyassets
Index
|
Files
package lazyassets
import "golazy.dev/lazyassets"Types
type Asset
type Asset struct {
Path string `json:"path"`
Permanent string `json:"permanent,omitempty"`
ContentType string `json:"content_type,omitempty"`
Size int64 `json:"size"`
Hash string `json:"hash,omitempty"`
ETag string `json:"etag,omitempty"`
Integrity string `json:"integrity,omitempty"`
Source string `json:"source,omitempty"`
Generated bool `json:"generated,omitempty"`
Ignored bool `json:"ignored,omitempty"`
// contains filtered or unexported fields
}func (a *Asset) Open
func (a *Asset) Open() (io.ReadCloser, error)type AssetOption
type AssetOption func(*assetOptions)func AssetSource
func AssetSource(name string) AssetOptionfunc ContentType
func ContentType(contentType string) AssetOptionfunc ReplaceAsset
func ReplaceAsset() AssetOptiontype CachePolicy
type CachePolicy stringtype Manifest
type Manifest struct {
Assets []Asset `json:"assets"`
}type OpenFunc
type OpenFunc func() (io.ReadCloser, error)type Option
type Option func(*Options)func WithBaseURL
WithBaseURL makes helpers return absolute asset URLs while keeping request routing and storage keys path-based.
func WithBaseURL(baseURL string) Optionfunc WithCSSURLRewrite
func WithCSSURLRewrite(enabled bool) Optionfunc WithCachePolicies
func WithCachePolicies(logical, permanent CachePolicy) Optionfunc WithHashLength
func WithHashLength(length int) Optionfunc WithMaxAssetSize
func WithMaxAssetSize(size int64) Optionfunc WithOversizePolicy
func WithOversizePolicy(policy OversizePolicy) Optionfunc WithURLPrefix
func WithURLPrefix(prefix string) Optiontype Options
type Options struct {
URLPrefix string
MaxAssetSize int64
OversizePolicy OversizePolicy
HashLength int
LogicalCache CachePolicy
PermanentCache CachePolicy
RewriteCSSURLs bool
BaseURL string
}type OversizePolicy
type OversizePolicy inttype Registry
type Registry struct {
// contains filtered or unexported fields
}func New
func New(options ...Option) *Registryfunc (r *Registry) Add
func (r *Registry) Add(path string, content []byte, options ...AssetOption) errorfunc (r *Registry) AddFS
func (r *Registry) AddFS(files fs.FS, options ...SourceOption) errorfunc (r *Registry) AddReader
func (r *Registry) AddReader(path string, open OpenFunc, options ...AssetOption) errorfunc (r *Registry) Empty
func (r *Registry) Empty() boolfunc (r *Registry) Handler
func (r *Registry) Handler(next http.Handler) http.Handlerfunc (r *Registry) Helpers
func (r *Registry) Helpers() map[string]anyfunc (r *Registry) Integrity
func (r *Registry) Integrity(assetPath string) (string, error)func (r *Registry) Manifest
func (r *Registry) Manifest() Manifestfunc (r *Registry) MustPath
func (r *Registry) MustPath(assetPath string) stringfunc (r *Registry) Path
func (r *Registry) Path(assetPath string) (string, error)func (r *Registry) ServeHTTP
func (r *Registry) ServeHTTP(w http.ResponseWriter, req *http.Request)func (r *Registry) Unpack
func (r *Registry) Unpack(dir string, options ...UnpackOption) errorfunc (r *Registry) Upload
Upload writes registered assets to object storage.
The default mode writes only permanent content-hashed paths plus manifest.json, which is the usual shape for CDN or static-file ingress deployments.
func (r *Registry) Upload(ctx context.Context, storage lazystorage.Writer, options ...UploadOption) errortype Source
type Source interface {
Assets(*Registry) error
}type SourceFunc
type SourceFunc func(*Registry) errorfunc (fn SourceFunc) Assets
func (fn SourceFunc) Assets(registry *Registry) errortype SourceOption
type SourceOption func(*sourceOptions)func Replace
func Replace() SourceOptionfunc SourceName
func SourceName(name string) SourceOptiontype UnpackMode
type UnpackMode inttype UnpackOption
type UnpackOption func(*unpackOptions)func WithUnpackMode
func WithUnpackMode(mode UnpackMode) UnpackOptiontype UploadOption
type UploadOption func(*uploadOptions)func WithUploadMode
WithUploadMode selects which asset paths are written to storage.
func WithUploadMode(mode UnpackMode) UploadOptionfunc WithUploadPrefix
WithUploadPrefix writes assets below prefix in the destination storage.
func WithUploadPrefix(prefix string) UploadOptionfunc WithoutUploadManifest
WithoutUploadManifest disables writing manifest.json to storage.
func WithoutUploadManifest() UploadOption
Package lazyassets registers, fingerprints, and serves application assets.