npmpackage.info

Gathering detailed insights and metrics for serve-favicon

Other packages similar to serve-favicon

@types/serve-favicon

2.5.7

TypeScript definitions for serve-favicon

fastify-favicon

5.0.0

Fastify plugin to serve default favicon requests

empty-favicon

0.1.0

Serve an empty favicon

@robireton/serve-favicon

3.0.1

favicon serving middleware with caching

Gathering detailed insights and metrics for serve-favicon

serve-favicon - 2.5.1 | npmpackage.info

serve-favicon

favicon serving middleware

2.5.1

623

MIT

JavaScript

14.67 kB

7.6

Installations

npm install serve-favicon

Developer Guide

BETA

Typescript

No

Module System

N/A

Min. Node Version

>= 0.8.0

Node Version

22.10.0

NPM Version

10.9.0 Pull Requests

Open

3

Total

42

Closed

15

Merged

24

Issues

Open

0

Total

30

Closed

30

Releases

2.5.1

Updated on Jun 10, 2025

2.5.0

Updated on Mar 29, 2018

2.4.5

Updated on Sep 26, 2017

2.4.4

v2.4.4

Updated on Sep 12, 2017

2.4.3

v2.4.3

Updated on May 16, 2017

2.4.2

v2.4.2

Updated on Mar 25, 2017

View All 23 releases

Languages

JavaScript

JavaScript (100%)

Developer

expressjs

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

623 Stars

231 Commits

75 Forks

19 Watchers

8 Branches

30 Contributors

Updated on Jul 10, 2025

Maintainers

View All 30 Contributors

Package Meta Information

Latest Version

2.5.1

Package Id

serve-favicon@2.5.1

Unpacked Size

14.67 kB

Size

5.76 kB

File Count

NPM Version

10.9.0

Node Version

22.10.0

Published on

Jun 10, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

etag fresh ms parseurl safe-buffer

Dev Dependencies

eslint eslint-config-standard eslint-plugin-import eslint-plugin-markdown eslint-plugin-node eslint-plugin-promise eslint-plugin-standard mocha nyc supertest temp-path

serve-favicon

Node.js middleware for serving a favicon.

A favicon is a visual cue that client software, like browsers, use to identify a site. For an example and more information, please visit the Wikipedia article on favicons.

Why use this module?

User agents request favicon.ico frequently and indiscriminately, so you may wish to exclude these requests from your logs by using this middleware before your logger middleware.
This module caches the icon in memory to improve performance by skipping disk access.
This module provides an ETag based on the contents of the icon, rather than file system properties.
This module will serve with the most compatible Content-Type.

Note This module is exclusively for serving the "default, implicit favicon", which is GET /favicon.ico. For additional vendor-specific icons that require HTML markup, additional middleware is required to serve the relevant files, for example serve-static.

Install

This is a Node.js module available through the npm registry. Installation is done using the npm install command:

1$ 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 year. 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

1var express = require('express')
2var favicon = require('serve-favicon')
3var path = require('path')
4
5var app = express()
6app.use(favicon(path.join(__dirname, 'public', 'favicon.ico')))
7
8// Add your routes here, etc.
9
10app.listen(3000)

connect

1var connect = require('connect')
2var favicon = require('serve-favicon')
3var path = require('path')
4
5var app = connect()
6app.use(favicon(path.join(__dirname, 'public', 'favicon.ico')))
7
8// Add your middleware here, etc.
9
10app.listen(3000)

vanilla http server

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

1var http = require('http')
2var favicon = require('serve-favicon')
3var finalhandler = require('finalhandler')
4var path = require('path')
5
6var _favicon = favicon(path.join(__dirname, 'public', 'favicon.ico'))
7
8var server = http.createServer(function onRequest (req, res) {
9  var done = finalhandler(req, res)
10
11  _favicon(req, res, function onNext (err) {
12    if (err) return done(err)
13
14    // continue to process the request here, etc.
15
16    res.statusCode = 404
17    res.end('oops')
18  })
19})
20
21server.listen(3000)

License

MIT

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Dependency-Update-Tool

Determines if the project uses a dependency update tool.

10

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

10

Contributors

Determines if the project has a set of contributors from multiple organizations (e.g., companies).

8

SAST

Determines if the project uses static code analysis.

8

CI-Tests

Determines if the project runs tests before pull requests are merged.

7

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

4

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Fuzzing

Determines if the project uses fuzzing.

Score

7.6

/10

Last Scanned on 2025-07-07T21:23:56Z

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More