discoverFavicons

Discovers favicon URLs from a webpage or feed.

Signature

function discoverFavicons(
  input: DiscoverInput,
  options?: DiscoverOptions<FaviconResult>,
): Promise<Array<DiscoverResult<FaviconResult>>>

Parameters

input

The URL to discover favicons from. Can be a string or an object:

// String - URL to fetch and scan
discoverFavicons('https://example.com', options)

// Object - provide existing content/headers
discoverFavicons({
  url: 'https://example.com',
  content: htmlContent,
  headers: responseHeaders,
}, options)

options

All options are optional. When not provided, sensible defaults are used.

Property	Type	Default	Description
methods	DiscoverMethodsConfig	['platform', 'feed', 'html', 'headers', 'guess']	Which methods to use
fetchFn	DiscoverFetchFn	native fetch	Custom fetch function
extractFn	DiscoverExtractFn	status check	Custom extraction function
resolveUrlFn	DiscoverResolveUrlFn		Custom URL resolution function
stopOnFirstMethod	boolean	false	Stop URI collection after first method with results
stopOnFirstResult	boolean	false	Stop after first valid favicon
concurrency	number	3	Max parallel validations
includeInvalid	boolean	false	Include invalid results
onProgress	DiscoverOnProgressFn		Progress callback

Return Value

Returns a promise that resolves to an array of results:

// Valid result
{
  url: 'https://example.com/favicon.ico',
  isValid: true,
  method: 'html',
}

// Invalid result (when includeInvalid: true)
{
  url: 'https://example.com/missing.png',
  isValid: false,
  method: 'guess',
  error: Error,
}

Examples

Basic Usage

import { discoverFavicons } from 'feedscout'

// Simple usage - all methods enabled by default
const favicons = await discoverFavicons('https://example.com')

// Or specify which methods to use
const favicons = await discoverFavicons('https://example.com', {
  methods: ['html', 'headers', 'guess'],
})

With Custom Options

const favicons = await discoverFavicons('https://example.com', {
  methods: {
    guess: {
      uris: ['/favicon.ico', '/icon.svg'],
    },
  },
  stopOnFirstResult: true,
})