A library that aids in static asset cache busting with SHA-256 hashes
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
|
||
---|---|---|
.github/workflows | ||
.reuse | ||
dist | ||
examples/actix-web | ||
LICENSES | ||
src | ||
.gitignore | ||
.woodpecker.yml | ||
Cargo.lock | ||
Cargo.toml | ||
CHANGELOG.md | ||
README.md |
What is cache busting?
To optimise network load time, browsers cache static files. Caching greatly improves performance but how do you inform browsers to invalidate cache when your files have changed?
Cache busting is a simple but effective solution for this issue. There are several ways to achieve this but the way this library does this is by changing file names to include the hash of the files' contents.
So if you have bundle.js
, it will become
bundle.<long-sha256-hash>.js
. This lets you set a super long cache age
as, because of the file names changing, the path to the filename, too,
will change. So as far as the browser is concerned, you are trying to load
a file that it doesn't have. Pretty neat, isn't it?
Features
SHA-256
based name generation during compile-time- Processes files based on provided MIME filters
- Exclude certain files from processing based on file extensions and/or file paths
- Exposes modified names to program during runtime
- Route prefixes(optional)
Usage:
Add this to your Cargo.toml
:
libcachebust = 0.2
Examples:
- See acix-example
- See mCaptcha/mcaptcha for use with Sailfish template engine.