Package Exports

egg-static/app/middleware/static.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (egg-static) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

egg-static

Static server plugin for egg, base on koa-static-cache.

Install

egg-static is a plugin that has been built-in for egg. It is enabled by default.

Configuration

egg-static support all configurations in koa-static-cache. and with default configurations below:

prefix: '/public/'
dir: path.join(appInfo.baseDir, 'app/public')
dynamic: true
preload: false
maxAge: 31536000 in prod env, 0 in other envs
buffer: true in prod env, false in other envs

egg-static provides one more option:

maxFiles: the maximum value of cache items, only effective when dynamic is true, default is 1000.

All static files in $baseDir/app/public can be visited with prefix /public, and all the files are lazy loaded.

In non-production environment, assets won't be cached, your modification can take effect immediately.
In production environment, egg-static will cache the assets after visited, you need to restart the process to update the assets.
Dir default is $baseDir/app/public but you can also define multiple directory by use dir: [dir1, dir2, ...] or dir: [dir1, { prefix: '/static2', dir: dir2 }], static server will use all these directories.

// {app_root}/config/config.default.js
exports.static = {
  // maxAge: 31536000,
};

Questions & Suggestions

Please open an issue here.

License

MIT

Contributors

_dead-horse	_fengmk2	_atian25	_popomore	_okoala	_airyland
_helloyou2012	_maxming2333

This project follows the git-contributor spec, auto updated at Sun Feb 12 2023 17:38:47 GMT+0800.