You can install via npm or bower:

npm install --save rss-parser # or bower install --save rss-parser

You can parse RSS from a URL, local file (NodeJS only), or a string.

• parseString(xml, [options,], callback)
• parseFile(filename, [options,], callback)
• parseURL(url, [options,] callback)

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

• 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)

var parser = require('rss-parser'); parser.parseURL('https://www.reddit.com/.rss', function(err, parsed) { console.log(parsed.feed.title); parsed.feed.entries.forEach(function(entry) { console.log(entry.title + ':' + entry.link); }) })

<script src="/bower_components/rss-parser/dist/rss-parser.min.js"></script> <script> RSSParser.parseURL('https://www.reddit.com/.rss', function(err, parsed) { console.log(parsed.feed.title); parsed.feed.entries.forEach(function(entry) { console.log(entry.title + ':' + entry.link); }) }) </script>

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

parser.parseURL('https://reddit.com/.rss', {maxRedirects: 3}, function(err, parsed) { console.log(parsed.feed.title); });

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

var options = { customFields: { feed: ['otherTitle', 'extendedDescription'], item: ['coAuthor','subtitle'], } } parser.parseURL('https://www.reddit.com/.rss', options, function(err, parsed) { console.log(parsed.feed.extendedDescription); parsed.feed.entries.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]:

var options = { customFields: { item: [ ['dc:coAuthor', 'coAuthor'], ] } }

Contributions welcome!

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

# change version in package.json grunt build git commit -a -m "vX.X.X" git tag vX.X.X npm publish git push --follow-tags