discoverBlogrolls

Discovers and validates OPML blogrolls from a webpage.

Signature

function discoverBlogrolls(
  input: DiscoverInput,
  options?: DiscoverOptions<BlogrollResult>,
): Promise<Array<DiscoverResult<BlogrollResult>>>

Parameters

input

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

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

// Object - provide existing content/headers
discoverBlogrolls({
  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	['html', 'headers', 'guess']	Which methods to use
fetchFn	DiscoverFetchFn	native fetch	Custom fetch function
extractFn	DiscoverExtractFn	feedsmith	Custom OPML extraction function
normalizeUrlFn	DiscoverNormalizeUrlFn		Custom URL normalization function
concurrency	number	3	Max parallel validations
stopOnFirstResult	boolean	false	Stop after first valid blogroll
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/blogroll.opml',
  isValid: true,
  title: 'My Reading List',
}

// Invalid result (when includeInvalid: true)
{
  url: 'https://example.com/not-opml.xml',
  isValid: false,
  error: Error,
}

Examples

Basic Usage

import { discoverBlogrolls } from 'feedscout'

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

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

With Custom Options

import { urisComprehensive } from 'feedscout/blogrolls'

const blogrolls = await discoverBlogrolls('https://example.com', {
  methods: {
    html: {
      anchorLabels: ['blogroll', 'opml'],
    },
    guess: {
      uris: urisComprehensive,
    },
  },
})