API Reference

This section documents all public functions and types exported by Feedscout.

Main Functions

Function	Description	Import
discoverFeeds	Discover and validate feeds from a URL	feedscout
discoverBlogrolls	Discover and validate OPML blogrolls	feedscout
discoverFavicons	Discover and validate favicons	feedscout
discoverHubs	Discover WebSub hubs from feeds	feedscout

Discovery Method Functions

These functions extract URIs without validation. Import from feedscout/methods:

Function	Description
discoverUrisFromPlatform	Generate feed URIs for known platforms
discoverUrisFromFeed	Extract URIs from feed content
discoverUrisFromHtml	Extract feed URIs from HTML content
discoverUrisFromHeaders	Extract feed URIs from HTTP headers
discoverUrisFromGuess	Generate feed URIs from common paths

Utility Functions

Import from feedscout/methods:

Function	Description
getWwwCounterpart	Get www/non-www variant of a URL
getSubdomainVariants	Generate subdomain variants of a URL
generateUrlCombinations	Combine base URLs with URI paths

Import from feedscout/utils:

Function	Description
isSubdomainOf	Check if URL is subdomain of domain
isHostOf	Check if URL host matches any in list
includesAnyOf	Check if string includes any pattern
isAnyOf	Check if string equals any pattern
anyWordMatchesAnyOf	Check if any word matches patterns
endsWithAnyOf	Check if string ends with any pattern
omitEmpty	Drop empty values from an array

Import from feedscout:

Function	Description
getFeedSiteUrl	Get the site URL from a feed parsed with Feedsmith
defaultResolveSiteUrlFn	Default site URL resolution used by discoverBlogrolls and discoverFavicons

Export Paths

Feedscout uses multiple export paths for tree-shaking:

// Main exports
import { discoverFeeds, discoverBlogrolls, discoverFavicons, discoverHubs } from 'feedscout'
import type { DiscoverUriEntry, DiscoverUriHint, UriEntry } from 'feedscout'

// Feed-specific defaults and types
import { mimeTypes, urisBalanced } from 'feedscout/feeds'

// Blogroll-specific defaults and types
import { urisComprehensive } from 'feedscout/blogrolls'

// Favicon-specific defaults and types
import { defaultGuessPaths, defaultIconRels } from 'feedscout/favicons'

// Hub-specific types
import type { HubResult, DiscoverHubsOptions } from 'feedscout/hubs'

// Platform-specific handlers and types
import { youtubeHandler, defaultPlatformOptions } from 'feedscout/platform'
import type { PlatformHandler } from 'feedscout/platform'

// Discovery method functions
import { discoverUrisFromPlatform, discoverUrisFromHtml } from 'feedscout/methods'

// Utility functions
import { isSubdomainOf, isHostOf } from 'feedscout/utils'