Skip to content
generated from tinyhttp/repo-template

Node.js middleware to serve `favicon.ico` file.

License

Notifications You must be signed in to change notification settings

tinyhttp/favicon

Repository files navigation

@tinyhttp/favicon

npm GitHub Workflow Status Coverage

A rewrite of serve-favicon module.

Node.js middleware to serve favicon.ico file.

Install

pnpm i @tinyhttp/favicon

API

import { favicon } from '@tinyhttp/favicon'

Options

favicon accepts these properties in the options object.

path

Path to icon, required. Passed as the first argument.

maxAge

Sets Cache-Control: maxAge= header, optional. Default is one year. Passed with object in the second argument.

Example

import { favicon } from '@tinyhttp/favicon'
import { createServer } from 'node:http'
import path from 'node:path'

createServer(favicon(path.join(process.cwd(), 'public', 'favicon.ico')).listen(3000)