Quick Start

Basic installation and common usage patterns.

Installation

Feedcanon works in both Node and modern browsers as either CommonJS or ES module.

Install the package using your preferred package manager:

npm

npm install feedcanon

yarn

yarn add feedcanon

pnpm

pnpm add feedcanon

bun

bun add feedcanon

Basic Usage

When you just need to clean up a feed URL and get its canonical form.

import { findCanonical } from 'feedcanon'

const url = await findCanonical('http://www.example.com/feed/?utm_source=twitter')

// 'https://example.com/feed'

Returns undefined if the feed is invalid or unreachable.

Using Callbacks

When you want to log the canonicalization process for debugging. Or store all URL aliases that resolve to the same feed.

import { findCanonical } from 'feedcanon'

const aliases = []

const url = await findCanonical('http://www.example.com/feed/', {
  onMatch: ({ url }) => {
    aliases.push(url)
  },
})

// url: 'https://example.com/feed'
// aliases: [
//   'http://www.example.com/feed/',
//   'https://www.example.com/feed/',
//   'https://example.com/feed',
// ]

See Using Callbacks for the full guide.