https://github.com/a7ul/rss-parser-browser
A simple, light-weight RSS parser for browser. Parse strings, URLs and get a JS object back
https://github.com/a7ul/rss-parser-browser
browser npm openlibrary rss rss-parser rss-reader
Last synced: about 1 month ago
JSON representation
A simple, light-weight RSS parser for browser. Parse strings, URLs and get a JS object back
- Host: GitHub
- URL: https://github.com/a7ul/rss-parser-browser
- Owner: a7ul
- License: mit
- Created: 2017-07-05T10:31:11.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-07-05T10:41:06.000Z (almost 8 years ago)
- Last Synced: 2025-04-05T02:22:18.480Z (2 months ago)
- Topics: browser, npm, openlibrary, rss, rss-parser, rss-reader
- Language: JavaScript
- Homepage:
- Size: 1.18 MB
- Stars: 10
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rss-parser-browser
[](https://travis-ci.org/master-atul/rss-parser-browser)
This is a direct clone from https://github.com/bobby-brennan/rss-parser
I have removed the node dependencies so that it works with webpack in browser.
All credits should go to bobby-brennan.
## Installation
You can install via npm:
```bash
npm install --save rss-parser-browser
# or
yarn add rss-parser-browser
```
## Usage
You can parse RSS from a URL or a string.
* `parseString(xml, [options,], callback)`
* `parseURL(url, [options,] callback)`
## Output
Check out the full output format in [test/output/reddit.json](test/output/reddit.json)
##### Notes:
* 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](http://www.lowter.com/blogs/2008/2/9/rss-dccreator-author))
### Usage
```js
var parser = require('rss-parser-browser');
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);
})
})
```
### Redirects
By default, `parseURL` will follow up to one redirect. You can change this
with `options.maxRedirects`.
```js
parser.parseURL('https://reddit.com/.rss', {maxRedirects: 3}, function(err, parsed) {
console.log(parsed.feed.title);
});
```
### Custom Fields
If your RSS feed contains fields that aren't currently returned, you can access them using the `customFields` option.
```js
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]`:
```js
var options = {
customFields: {
item: [
['dc:coAuthor', 'coAuthor'],
]
}
}
```
## Contributing
Contributions welcome!
### Running Tests
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`
### Publishing Releases
```bash
# 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
```