35 lines
728 B
Markdown
35 lines
728 B
Markdown
# koa-favicon [](https://travis-ci.org/koajs/favicon)
|
|
|
|
Koa middleware for serving a favicon. Based on [serve-favicon](https://github.com/expressjs/serve-favicon).
|
|
|
|
## Installation
|
|
|
|
```js
|
|
$ npm install koa-favicon
|
|
```
|
|
|
|
## Example
|
|
|
|
```js
|
|
const Koa = require('koa');
|
|
const favicon = require('koa-favicon');
|
|
const app = new Koa();
|
|
|
|
app.use(favicon(__dirname + '/public/favicon.ico'));
|
|
```
|
|
|
|
## API
|
|
|
|
### favicon(path, [options])
|
|
|
|
Returns a middleware serving the favicon found on the given `path`.
|
|
|
|
#### options
|
|
|
|
- `maxAge` cache-control max-age directive in ms, defaulting to 1 day.
|
|
- `mime` specify the mime-type of the favicon, defaults to "image/x-icon"
|
|
|
|
## License
|
|
|
|
MIT
|