Class FaviconExtractor

The FaviconExtractor class parses HTML and manifest files to extract favicon and app icon URLs for standard, Apple, and Android platforms.

Index

Constructors

Methods

addMimeTypes fetchAndExtract getLargestIconsByMimeType groupIcons

Constructors

constructor

new FaviconExtractor(): FaviconExtractor
Returns FaviconExtractor

Methods

addMimeTypes

addMimeTypes(icons: string[] | IconEntry[]): IconEntry[]
Adds MIME types to icon URLs based on file extensions.
Parameters
- icons: string[] | IconEntry[]
  A list of icon URLs or objects with a url key.
Returns IconEntry[]
A list of icon objects with inferred MIME types.
- Defined in index.ts:130

fetchAndExtract

fetchAndExtract(url: string): Promise<string[]>
Fetches the page and extracts all icon URLs, including manifest-defined ones.
Parameters
- url: string
  The full page URL to extract icons from.
Returns Promise<string[]>
A list of fully resolved absolute icon URLs.

Throws
If the page fails to fetch.
- Defined in index.ts:40

getLargestIconsByMimeType

getLargestIconsByMimeType(icons: string[] | IconEntry[]): IconEntry[]
Selects the largest icon found for each unique MIME type.
Parameters
- icons: string[] | IconEntry[]
  List of icons with MIME types and optional sizes.
Returns IconEntry[]
One icon per MIME type, prioritized by size.
- Defined in index.ts:98

groupIcons

groupIcons(
    iconUrls: string[],
): {
    androidIcons: IconEntry[];
    appleTouchIcons: IconEntry[];
    standardIcons: IconEntry[];
}
Organizes a list of icons into platform-specific categories.
Parameters
- iconUrls: string[]
  The raw list of icon URLs.
Returns {
    androidIcons: IconEntry[];
    appleTouchIcons: IconEntry[];
    standardIcons: IconEntry[];
}
Grouped icon categories.
- Defined in index.ts:65