A StealJS and SystemJS cache busting extension.
Deprecated: this package is now built into steal. See the cacheVersion documentation for more details.
You can install through NPM:
npm install steal-cache-bust --save
You'll then want to copy node_modules/steal-cache-bust/cache-bust.js to a location within your project folder. In the future this extension will be included in Steal by default.
With StealJS simply include cache-bust as a configDependency. Assuming you placed it in your root folder:
{
"system": {
"configDependencies": [
"cache-bust"
]
}
}If you prefer leaving cache-bust in your node_modules folder you should use the full path to the cache-bust.js file:
{
"system": {
"configDependencies": [
"node_modules/steal-cache-bust/cache-bust.js"
]
}
}When not running in production the cacheVersion is ignored and a timestamp is added instead. As some files do not pass through steal no cache busting can be applied to those. When developing using Chrome as your browser you may want to tick the 'Disable cache (while DevTools is open)' checkbox under Settings | Preferences | Network to prevent caching altogether while you are developing.
You can configure cache busting by setting properties on the script tag. You'll probably at least want to set cacheVersion.
This is the version string that will be appending as a query parameter inwhen running in production. For example if you do:
<script src="node_modules/steal/steal.js" cache-version="14"></script>Then requests will be for:
http://example.com/foo/bar.js?version=14
This version should be changed for each production release to ensure that the latest code is retrieved from the server.
If you do not specify a cacheVersion value a timestamp will be added as the cache busting parameter. This is not ideal for a production environment as you will lose all the benefits of browser caching.
By default "version" is used as the query param for busting caches but you can use a different string by setting cacheKey.
MIT