https://github.com/kaelzhang/egg-serve-static

Utilities to create roe/egg route definitions to serve static files.
https://github.com/kaelzhang/egg-serve-static

egg roe

Last synced: 20 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/kaelzhang/egg-serve-static
• Owner: kaelzhang
• License: other
• Created: 2019-03-23T06:56:12.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-07-01T10:32:33.000Z (over 5 years ago)
• Last Synced: 2024-12-13T13:16:04.789Z (21 days ago)
• Topics: egg, roe
• Language: JavaScript
• Homepage:
• Size: 14.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/kaelzhang/egg-serve-static.svg?branch=master)](https://travis-ci.org/kaelzhang/egg-serve-static)

[![Coverage](https://codecov.io/gh/kaelzhang/egg-serve-static/branch/master/graph/badge.svg)](https://codecov.io/gh/kaelzhang/egg-serve-static)

# egg-serve-static

Utilities to create [roe](https://github.com/kaelzhang/roe)/[egg](https://npmjs.org/package/egg) route definitions to serve static files.

## Install

```sh

$ npm i egg-serve-static

```

## Usage

```

project

|-- app

|   |-- router.js

|-- static

|   |-- a.js

|-- compressed

|   |-- a.min.js

```

app/router.js

```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:

```sh

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

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

```

## License

MIT