egg-static
static server plugin for egg
Last updated 4 months ago by atian25 .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install egg-static 
SYNC missed versions from official npm registry.

egg-static

NPM version build status Test coverage David deps Known Vulnerabilities npm download

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

Current Tags

  • 2.2.0                                ...           latest (4 months ago)
  • 1.5.1                                ...           latest-1 (a year ago)

15 Versions

  • 2.2.0                                ...           4 months ago
  • 2.1.1                                ...           a year ago
  • 1.5.1                                ...           a year ago
  • 1.5.0                                ...           a year ago
  • 2.1.0                                ...           a year ago
  • 2.0.0                                ...           2 years ago
  • 1.4.1                                ...           2 years ago
  • 1.4.0                                ...           2 years ago
  • 1.3.0                                ...           2 years ago
  • 1.2.0                                ...           2 years ago
  • 1.1.0                                ...           2 years ago
  • 1.0.0                                ...           3 years ago
  • 0.1.0                                ...           3 years ago
  • 0.0.2                                ...           3 years ago
  • 0.0.1                                ...           3 years ago
Downloads
Today 474
This Week 2,521
This Month 17,773
Last Day 1,042
Last Week 5,321
Last Month 26,008
Dependencies (6)
Dev Dependencies (8)

Copyright 2014 - 2016 © taobao.org |