@rowanmanning/feed-parser NPM

@rowanmanning/feed-parser

A well-tested and resilient Node.js parser for RSS and Atom feeds.

:warning: This project is not ready for production use yet, and is missing a lot of features :warning:

Introduction

This is a Node.js-based feed parser for RSS and Atom feeds. The project has the following aims:

Run automated tests against real-world feeds. It's currently tested against ~40 feeds via Sample Feeds. This ensures that we support real feeds rather than just the specifications.
Related to the point above, be as lenient as possible with feed parsing.
Keep up to date with the latest Node.js versions, including dropping support for end-of-life versions.
Maintain compatibility with the great parts of node-feedparser, e.g. resolving relative URLs.

Requirements

This library requires the following to run:

Node.js 18+

Usage

Install with npm:

npm install @rowanmanning/feed-parser

Load the library into your code with a require call:

const parseFeed = require('@rowanmanning/feed-parser');

You can use the parseFeed function to parse an RSS or Atom feed as a string. The return value is an object representation of the feed:

const feed = parseFeed('<channel> etc. </channel>');
console.log(feed.title);

This will try to parse even invalid feeds, but if no data can be pulled out an error will be thrown with a code property set to INVALID_FEED.

Parsed feed

The feed object returned by parseFeed has the following properties.

`Feed`

Represents an RSS or Atom feed.

`FeedAuthor`

Represents the author of a Feed or FeedItem.

`FeedCategory`

Represents the content category of a Feed or FeedItem.

`FeedGenerator`

Represents software that generated a Feed.

`FeedImage`

Represents an image for a Feed.

`FeedItem`

Represents an RSS item or Atom entry in a Feed.

`FeedItemMedia`

Represents a piece of media attached to a FeedItem.

`FeedMeta`

Represents meta information about a Feed.

Supported feed formats

Standards

Feeds that adhere to the following standards are supported and most properties will be parsed:

Atom 1.0
Atom 0.3 (no spec available but an example is here)
RSS 2.0
RSS 0.9
RDF Site Summary 1.0

The following XML namespaces are also parsed, and more data will be parsed out for RSS feeds that implement these:

DublinCore (e.g. dc:creator)
iTunes Podcast RSS feed (e.g. itunes:author)

Leniency

Feeds in the real world rarely comply strictly with the standards and can sometimes be invalid XML. We try to be as lenient as possible, only throwing errors if no data can be pulled out of the feed. We test against a suite of real-world feeds.