Neonatal Penguin March

    serve-favicons

    2.1.5 • Public • Published

    serve-favicon

    NPM Version NPM Downloads Build Status Test Coverage Gittip

    Node.js middleware for serving a favicon.

    Install

    npm install serve-favicon

    API

    favicon(path, options)

    Create new middleware to serve a favicon from the given path to a favicon file. path may also be a Buffer of the icon to serve.

    Options

    Serve favicon accepts these properties in the options object.

    maxAge

    The cache-control max-age directive in ms, defaulting to 1 day. This can also be a string accepted by the ms module.

    Examples

    Typically this middleware will come very early in your stack (maybe even first) to avoid processing any other middleware if we already know the request is for /favicon.ico.

    express

    var express = require('express');
    var favicon = require('serve-favicon');
     
    var app = express();
    app.use(favicon(__dirname + '/public/favicon.ico'));
     
    // Add your routes here, etc.
     
    app.listen(3000);

    multiple icons

    app.use(favicon({
        '/favicon.ico': __dirname + '/public/favicon.ico',
        '/favicon-152.png': __dirname + '/public/favicon-152.png',
        '/favicon-144.png': new Buffer(20)
    }));

    connect

    var connect = require('connect');
    var favicon = require('serve-favicon');
     
    var app = connect();
    app.use(favicon(__dirname + '/public/favicon.ico'));
     
    // Add your middleware here, etc.
     
    app.listen(3000);

    vanilla http server

    This middleware can be used anywhere, even outside express/connect. It takes req, res, and callback.

    var http = require('http');
    var favicon = require('serve-favicon');
    var finalhandler = require('finalhandler');
     
    var _favicon = favicon(__dirname + '/public/favicon.ico');
     
    var server = http.createServer(function onRequest(req, res) {
      var done = finalhandler(req, res);
     
      _favicon(req, res, function onNext(err) {
        if (err) return done(err);
     
        // continue to process the request here, etc.
     
        res.statusCode = 404;
        res.end('oops');
      });
    });
     
    server.listen(3000);

    License

    MIT

    Install

    npm i serve-favicons

    DownloadsWeekly Downloads

    47

    Version

    2.1.5

    License

    MIT

    Last publish

    Collaborators

    • doublerebel