egg-serve-static v2.1.2

egg-serve-static

Utilities to create roe/egg route definitions to serve static files.

Install

$ npm i egg-serve-static

Usage

project
|-- app
|   |-- router.js
|-- static
|   |-- a.js
|-- compressed
|   |-- a.min.js

app/router.js

const define = require('egg-serve-static')

module.exports = define({
  '/js': 'static',
  '/min': {
    root: 'compressed',
    // Override the default max-age
    maxAge: 60000
  }
}, {
  root: '/path/to/project',
  // Default max-age in miniseconds
  maxAge: 120000
})

define(files, options)

• files Object static files to serve
• options Object configurations
  • root path root path to search the files
  • maxAge? number=0 Browser cache max-age in milliseconds

Returns Function(app) a roe/egg router function which accepts app as the only one parameter.

define.serve(app, path, root, options)

• app RoeApplication | EggApplication
• path string pathname of the request
• root path
• options Object the same as above

Add the router definition to app, then:

curl http://localhost:$port$path/a.js

# The content of file `${root}/a.js` will be sent

License

MIT