mirror of https://github.com/tinyhttp/favicon.git
v1rtl a2a4768d4b | ||
---|---|---|
.github | ||
.husky | ||
src | ||
tests | ||
.eslintrc | ||
.gitignore | ||
.prettierrc | ||
LICENSE | ||
README.md | ||
bun.lockb | ||
commitlint.config.cjs | ||
package.json | ||
tsconfig.eslint.json | ||
tsconfig.json |
README.md
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)