koa-favicon

What is koa-favicon?

The koa-favicon package is a middleware for Koa.js that serves a favicon for your web application. It is designed to be simple and efficient, allowing you to easily add a favicon to your Koa-based server.

What are koa-favicon's main functionalities?

Serve Favicon

This feature allows you to serve a favicon from a specified path. In this example, the favicon is located in the 'public' directory and is named 'favicon.ico'. The middleware is added to the Koa application using `app.use`.

const Koa = require('koa');
const favicon = require('koa-favicon');
const app = new Koa();

app.use(favicon(__dirname + '/public/favicon.ico'));

app.use(ctx => {
  ctx.body = 'Hello World';
});

app.listen(3000);

Other packages similar to koa-favicon

serve-favicon

The serve-favicon package is a middleware for Express.js that serves a favicon. It is similar to koa-favicon but is designed for use with Express.js instead of Koa.js. It provides similar functionality, allowing you to specify the path to your favicon and serve it efficiently.

koa-static

The koa-static package is a middleware for serving static files in Koa.js applications. While it is not specifically designed for serving favicons, it can be used to serve any static file, including favicons. This makes it a more versatile option compared to koa-favicon, but it may require additional configuration to serve a favicon specifically.

README

koa-favicon

Koa middleware for serving a favicon. Based on serve-favicon.

Installation

$ npm install koa-favicon

Example

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