rss-parser

[![Version][npm-image]][npm-link]
[![Build Status][build-image]][build-link]
[![Downloads][downloads-image]][npm-link]

[downloads-image]: https://img.shields.io/npm/dm/rss-parser.svg
[npm-image]: https://img.shields.io/npm/v/rss-parser.svg
[npm-link]: https://npmjs.org/package/rss-parser
[build-image]: https://github.com/rbren/rss-parser/workflows/tests/badge.svg
[build-link]: https://github.com/rbren/rss-parser/actions

A small library for turning RSS XML feeds into JavaScript objects.

Installation

``bash
npm install --save rss-parser
`

Usage

You can parse RSS from a URL (parser.parseURL) or an XML string (parser.parseString).

Both callbacks and Promises are supported.

$3

Here's an example in NodeJS using Promises with async/await:

`js
let Parser = require('rss-parser');
let parser = new Parser();

(async () => {

let feed = await parser.parseURL('https://www.reddit.com/.rss');
console.log(feed.title);

feed.items.forEach(item => {
console.log(item.title + ':' + item.link)
});

})();
`

$3

When using TypeScript, you can set a type to control the custom fields:

`typescript
import Parser from 'rss-parser';

type CustomFeed = {foo: string};
type CustomItem = {bar: number};

const parser: Parser = new Parser({
customFields: {
feed: ['foo', 'baz'],
// ^ will error because baz is not a key of CustomFeed
item: ['bar']
}
});

(async () => {

const feed = await parser.parseURL('https://www.reddit.com/.rss');
console.log(feed.title); // feed will have a foo property, type as a string

feed.items.forEach(item => {
console.log(item.title + ':' + item.link) // item will have a bar property type as a number
});
})();
`

$3


> We recommend using a bundler like webpack, but we also provide
> pre-built browser distributions in the dist/ folder. If you use the pre-built distribution,
> you'll need a polyfill for Promise support.

Here's an example in the browser using callbacks:

`html


`

$3

A few minor breaking changes were made in v3. Here's what you need to know:

* You need to construct a new Parser() before calling parseString or parseURL
* parseFile is no longer available (for better browser support)
* options are now passed to the Parser constructor
* parsed.feed is now just feed (top-level object removed)
* feed.entries is now feed.items (to better match RSS XML)




Output

Check out the full output format in test/output/reddit.json

`yaml
feedUrl: 'https://www.reddit.com/.rss'
title: 'reddit: the front page of the internet'
description: ""
link: 'https://www.reddit.com/'
items:
- title: 'The water is too deep, so he improvises'
link: 'https://www.reddit.com/r/funny/comments/3skxqc/the_water_is_too_deep_so_he_improvises/'
pubDate: 'Thu, 12 Nov 2015 21:16:39 +0000'
creator: "John Doe"
content: 'this is a link & this is bold text'
contentSnippet: 'this is a link & this is bold text'
guid: 'https://www.reddit.com/r/funny/comments/3skxqc/the_water_is_too_deep_so_he_improvises/'
categories:
- funny
isoDate: '2015-11-12T21:16:39.000Z'
`

##### Notes:
* The contentSnippet field strips out HTML tags and unescapes HTML entities
* The dc: prefix will be removed from all fields
* Both dc:date and pubDate will be available in ISO 8601 format as isoDate
* If author is specified, but not dc:creator, creator will be set to author (see article)
* Atom's updated becomes lastBuildDate for consistency

XML Options

$3


If your RSS feed contains fields that aren't currently returned, you can access them using the customFields option.

`js
let parser = new Parser({
customFields: {
feed: ['otherTitle', 'extendedDescription'],
item: ['coAuthor','subtitle'],
}
});

parser.parseURL('https://www.reddit.com/.rss', function(err, feed) {
console.log(feed.extendedDescription);

feed.items.forEach(function(entry) {
console.log(entry.coAuthor + ':' + entry.subtitle);
})
})
`

To rename fields, you can pass in an array with two items, in the format [fromField, toField]:

`js
let parser = new Parser({
customFields: {
item: [
['dc:coAuthor', 'coAuthor'],
]
}
})
`

To pass additional flags, provide an object as the third array item. Currently there is one such flag:

keepArray (false) - set to true to return all* values for fields that can have multiple entries.
* includeSnippet (false) - set to true to add an additional field, ${toField}Snippet, with HTML stripped out

`js
let parser = new Parser({
customFields: {
item: [
['media:content', 'media:content', {keepArray: true}],
]
}
})
`

$3


If your RSS Feed doesn't contain a tag with a version attribute,
you can pass a defaultRSS option for the Parser to use:
`js
let parser = new Parser({
defaultRSS: 2.0
});
`

$3

rss-parser uses xml2js
to parse XML. You can pass these options
to new xml2js.Parser() by specifying options.xml2js:

`js
let parser = new Parser({
xml2js: {
emptyTag: '--EMPTY--',
}
});
`

HTTP Options

$3

You can set the amount of time (in milliseconds) to wait before the HTTP request times out (default 60 seconds):

`js
let parser = new Parser({
timeout: 1000,
});
`

$3


You can pass headers to the HTTP request:
`js
let parser = new Parser({
headers: {'User-Agent': 'something different'},
});
`

$3

By default, parseURL will follow up to five redirects. You can change this
with options.maxRedirects.

`js
let parser = new Parser({maxRedirects: 100});
`

$3


rss-parser uses http/https module
to do requests. You can pass these options
to http.get()/https.get() by specifying options.requestOptions:

e.g. to allow unauthorized certificate
`js
let parser = new Parser({
requestOptions: {
rejectUnauthorized: false
}
});
`

Contributing

Contributions are welcome! If you are adding a feature or fixing a bug, please be sure to add a test case

$3

The tests run the RSS parser for several sample RSS feeds in test/input and outputs the resulting JSON into test/output. If there are any changes to the output files the tests will fail.

To check if your changes affect the output of any test cases, run

npm test

To update the output files with your changes, run

WRITE_GOLDEN=true npm test

$3


`bash
npm run build
git commit -a -m "Build distribution"
npm version minor # or major/patch
npm publish
git push --follow-tags
``