Repository files navigation

Static cache middleware for koa.

Differences between this library and other libraries such asstatic:

• There is no directory orindex.html support.
• You may optionally store the data in memory - it streams by default.
• Caches the assets on initialization - you need to restart the process to update the assets.(can turn off with options.preload = false)
• Uses MD5 hash sum as an ETag.
• Uses.gz files if present on disk, like nginx gzip_static module

Forked fromhttps://github.com/koajs/static-cache, refactor with TypeScript to support CommonJS and ESM both.

npm install @eggjs/koa-static-cache

constpath=require('path');const{ staticCache}=require('@eggjs/koa-static-cache');app.use(staticCache(path.join(__dirname,'public'),{maxAge:365*24*60*60}));

• options.dir (str) - the directory you wish to serve, default toprocess.cwd.
• options.maxAge (int) - cache control max age for the files,0 by default.
• options.cacheControl (str) - optional cache control header. Overridesoptions.maxAge.
• options.buffer (bool) - store the files in memory instead of streaming from the filesystem on each request.
• options.gzip (bool) - when request's accept-encoding include gzip, files will compressed by gzip.
• options.usePrecompiledGzip (bool) - try use gzip files, loaded from disk, like nginx gzip_static
• options.alias (obj) - object map of aliases. See below.
• options.prefix (str) - the url prefix you wish to add, default to''.
• options.dynamic (bool) - dynamic load file which not cached on initialization.
• options.filter (function | array) - filter files at init dir, for example - skip non build (source) files. If array set - allow only listed files
• options.preload (bool) - caches the assets on initialization or not, default totrue. always work together withoptions.dynamic.
• options.files (obj) - optional files object. See below.

For example, if you have thisalias object:

constoptions={alias:{'/favicon.png':'/favicon-32.png'}}

Then requests to/favicon.png will actually return/favicon-32.png without redirects or anything.This is particularly important when servingfavicons as you don't want to store duplicate images.

You can pass in an optional files object.This allows you to do two things:

Instead of doing:

app.use(staticCache('/public/js'))app.use(staticCache('/public/css'))

You can do this:

constfiles={};// Mount the middlewareapp.use(staticCache('/public/js',{},files));// Add additional filesstaticCache('/public/css',{},files);

The benefit is that you'll have one less function added to the stack as well as doing one hash lookup instead of two.

For example, if you want to change the max age of/package.json, you can do the following:

constfiles={};app.use(staticCache('/public',{maxAge:60*60*24*365},files));files['/package.json'].maxAge=60*60*24*30;

You can pass in a lru cache instance which has tow methods:get(key) andset(key, value).

constLRU=require('lru-cache');constfiles=newLRU({max:1000});app.use(staticCache({dir:'/public',dynamic:true,  files,}));

MIT

Made withcontributors-img.