feedparser
Advanced tools
Readme
This module adds methods for RSS, Atom, and RDF feed parsing in node.js using Isaac Schlueter's sax parser.
Feedparser has a couple features you don't usually see:
npm install feedparser
.pipe() is back. The libxml-like helper methods will
probably be going away in the next minor (or major) version release -- as soon
as I'm sure the stream API is stable and compatible with Node v0.10.x.The easiest way to use feedparser is to just give it a readable stream.
var FeedParser = require('feedparser')
, request = require('request');
request('http://somefeedurl.xml')
.pipe(new FeedParser([options]))
.on('error', function(error) {
// always handle errors
})
.on('meta', function (meta) {
// do something
})
.on('article', function (article) {
// do something else
})
.on('end', function () {
// do the next thing
});
normalize - Set to false to override Feedparser's default behavior,
which is to parse feeds into an object that contains the generic properties
patterned after (although not identical to) the RSS 2.0 format, regardless
of the feed's format.
addmeta - Set to false to override Feedparser's default behavior, which
is to add the feed's meta information to each article.
feedurl - The url (string) of the feed. FeedParser is very good at
resolving relative urls in feeds. But some feeds use relative urls without
declaring the xml:base attribute any place in the feed. This is perfectly
valid, but we don't know know the feed's url before we start parsing the feed
and trying to resolve those relative urls. If we discover the feed's url, we
will go back and resolve the relative urls we've already seen, but this takes
a little time (not much). If you want to be sure we never have to re-resolve
relative urls (or if FeedParser is failing to properly resolve relative urls),
you should set the feedurl option. Otherwise, feel free to ignore this option.
string - the contents of the feedfilename - a local filename or remote urlThe first argument can be either a url or a request options object. The only
required option is uri, all others are optional. See
request for details
about what that request options object might look like.
url - fully qualified uri or a parsed url object from url.parse()readableStream - a Readable StreamSee the examples directory.
error - called with error whenever there is a an error of any kind (SAXError, Feedparser error, request error, etc.)meta - called with meta when it has been parsedarticle - called with a single article when each article has been parsedcomplete - called with meta and articles when parsing is completeend - called with no parameters when parsing is complete or aborted (e.g., due to error)response - called with the HTTP response only when a url has been fetched via parseUrl or parseFile304 - called with no parameters when when a url has been fetched with a conditional GET via parseUrl or parseFile and the remote server responds with '304 Not Modified'You can provide a callback (i.e., via the libxml-like helper methods) to be called when the feed is finished being parsed. Because the helper methods are deprecated, you should consider the ability to provide a callback deprecated, as well. Use events instead.
Feedparser parses each feed into a meta portion and one or more articles.
Regardless of the format of the feed, the meta and each article contain a
uniform set of generic properties patterned after (although not identical to)
the RSS 2.0 format, as well as all of the properties originally contained in the
feed. So, for example, an Atom feed may have a meta.description property, but
it will also have a meta['atom:subtitle'] property.
The purpose of the generic properties is to provide the user a uniform interface
for accessing a feed's information without needing to know the feed's format
(i.e., RSS versus Atom) or having to worry about handling the differences
between the formats. However, the original information is also there, in case
you need it. In addition, Feedparser supports some popular namespace extensions
(or portions of them), such as portions of the itunes, media, feedburner
and pheedo extensions. So, for example, if a feed article contains either an
itunes:image or media:thumbnail, the url for that image will be contained in
the article's image.url property.
All generic properties are "pre-initialized" to null (or empty arrays or
objects for certain properties). This should save you from having to do a lot of
checking for undefined, such as, for example, when you are using jade
templates.
In addition, all properties (and namespace prefixes) use only lowercase letters, regardless of how they were capitalized in the original feed. ("xmlUrl" and "pubDate" also are still used to provide backwards compatibility.) This decision places ease-of-use over purity -- hopefully, you will never need to think about whether you should camelCase "pubDate" ever again.
The title and description properties of meta and the title property of
each article have any HTML stripped if you let feedparser normalize the output.
If you really need the HTML in those elements, there are always the originals:
e.g., meta['atom:subtitle']['#'].
url and title properties)link property, origlink contains the original link)url and title properties)url and title properties pointing to the original source for an article; see the RSS Spec for an explanation of this element)url property and possibly type and length properties)article emissions)View all the contributors.
Although node-feedparser no longer shares any code with node-easyrss, it was
the original inspiration and a starting point.
(The MIT License)
Copyright (c) 2011, 2012, 2013 Dan MacTough and contributors
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
Robust RSS Atom and RDF feed parsing using sax js
The npm package feedparser receives a total of 8,829 weekly downloads. As such, feedparser popularity was classified as popular.
We found that feedparser demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.
Security News
A JavaScript library maintainer is under fire after merging a controversial PR to support legacy versions of Node.js.
Security News
Results from the 2023 State of JavaScript Survey highlight key trends, including Vite's dominance, rising TypeScript adoption, and the enduring popularity of React. Discover more insights on developer preferences and technology usage.