toajs / toa-favicon

Favicon middleware for toa.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

toa-favicon

Favicon middleware for toa.

NPM version Build Status Downloads

Demo

use as middleware:

const Toa = require('toa')
const favicon = require('toa-favicon')

const app = new Toa()
app.use(function () {
  this.body = 'Hi, toa-favicon!'
})

app.use(favicon('static/favicon.ico'))
app.listen(3000)

use as module:

const Toa = require('toa')
const favicon = require('toa-favicon')('examples')

const app = new Toa()
app.use(function *() {
  yield favicon
  this.body = 'Hi, toa-favicon!'
})

app.listen(3000)

Installation

npm install toa-favicon

API

const favicon = require('toa-favicon');

favicon([options])

Return a thunk function.

  • options.path (String) - The directory you wish to serve, default to process.cwd().
  • options.maxAge (Number) - Cache control max age (ms) for the files, default to 10 * 24 * 60 * 60 * 1000.

favicon('static') is equal to favicon({path: 'static'}).

favicon('static') is equal to favicon('static/favicon.ico').

favicon('static') is equal to favicon('process.cwd()/static/favicon.ico').

License

The MIT License (MIT)

About

Favicon middleware for toa.

License:MIT License


Languages

Language:JavaScript 100.0%