Ghost/core/server/web/shared/middleware/cache-control.js
Fabien "egg" O'Carroll 76b33b6e77 Added JSDoc to cache control middleware
no-issue
2022-01-14 14:04:23 +02:00

44 lines
1.2 KiB
JavaScript

// # CacheControl Middleware
// Usage: cacheControl(profile), where profile is one of 'public' or 'private'
// After: checkIsPrivate
// Before: routes
// App: Admin|Site|API
//
// Allows each app to declare its own default caching rules
const isString = require('lodash/isString');
/**
* @param {'public'|'private'} profile Use "private" if you do not want caching
* @param {object} [options]
* @param {number} [options.maxAge] The max-age in seconds to use when profile is "public"
*/
const cacheControl = (profile, options = {maxAge: 0}) => {
const profiles = {
public: `public, max-age=${options.maxAge}`,
private: 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0'
};
let output;
if (isString(profile) && Object.prototype.hasOwnProperty.call(profiles, profile)) {
output = profiles[profile];
}
/**
* @param {import('express').Request} req
* @param {import('express').Response} res
* @param {() => void} next
*
* @returns {void}
*/
return function cacheControlHeaders(req, res, next) {
if (output) {
res.set({'Cache-Control': output});
}
next();
};
};
module.exports = cacheControl;