# feed-read

> a ATOM and RSS feed parser

Latest version **0.0.1** (published 2012-03-19) · 0 weekly downloads

## Install

```sh
npm install feed-read
pnpm add feed-read
yarn add feed-read
bun add feed-read
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2012-03-19 |
| First published | 2012-03-19 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.4.1 |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 75 |
| Author | sentientwaffle |
| Maintainers | sentientwaffle |
| Keywords | atom, rss, feed, parser |

## Links

- npm: https://www.npmjs.com/package/feed-read
- Repository: https://github.com/sentientwaffle/feed-read
- Issues: https://github.com/sentientwaffle/feed-read/issues
- npm.io page: https://npm.io/package/feed-read

## Dependencies (3)

- [sax](https://npm.io/package/sax.md) 0.3.x
- [request](https://npm.io/package/request.md) 2.x.x
- [underscore](https://npm.io/package/underscore.md) 1.x.x

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2012-03-19

## README

# Feed-Read
[Node.js](http://nodejs.org/) 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.

---
_Source: https://npm.io/package/feed-read · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._