JSPM

feed-read

0.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1419
  • Score
    100M100P100Q89329F

a ATOM and RSS feed parser

Package Exports

  • feed-read

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (feed-read) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Feed-Read

Node.js module for parsing RSS and ATOM feeds into a common article object.

Installation

$ npm install feed-read

Usage

var feed = require("feed-read");

feed(url, callback)

Fetch a feed.

feed("http://craphound.com/?feed=rss2", function(err, articles) {
  if (err) throw err;
  // Each article has the following properties:
  // 
  //   * "title"     - The article title (String).
  //   * "author"    - The author's name (String).
  //   * "link"      - The original article link (String).
  //   * "content"   - The HTML content of the article (String).
  //   * "published" - The date that the article was published (Date).
  //   * "feed"      - {name, source, link}
  // 
});

feed.rss(rss_string, callback)

Parse a string of XML as RSS.

The callback receives (err, articles).

feed.atom(atom_string, callback)

Parse a string of XML as ATOM.

The callback receives (err, articles).

feed.identify(xml_string) // => "atom", "rss", or false

Identify what type of feed the XML represents.

Returns false when it is neither RSS or ATOM.

License

See LICENSE.