# feed-mixer

> Transform multiple rss/atom feeds into one rss/atom feed.

Latest version **0.1.1** (published 2016-07-12) · ISC license · 0 weekly downloads

## Install

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

## 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.1.1 |
| Published | 2016-07-12 |
| First published | 2016-07-10 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Aaron Acerboni |
| Maintainers | aaronacerboni |
| Keywords | feeds, rss, atom, aggregator, pipe, mixer, mix |

## Links

- npm: https://www.npmjs.com/package/feed-mixer
- Repository: https://github.com/AaronAcerboni/feed-mixer
- Homepage: https://github.com/AaronAcerboni/feed-mixer#readme
- Issues: https://github.com/AaronAcerboni/feed-mixer/issues
- npm.io page: https://npm.io/package/feed-mixer

## Dependencies (4)

- [q](https://npm.io/package/q.md) ^1.4.1
- [feed](https://npm.io/package/feed.md) ^0.3.0
- [request](https://npm.io/package/request.md) ^2.73.0
- [feedparser](https://npm.io/package/feedparser.md) ^1.1.4

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2016-07-12
- 0.1.0 — 2016-07-10
- 0.0.9 — 2016-07-10
- 0.0.8 — 2016-07-10
- 0.0.7 — 2016-07-10
- 0.0.6 — 2016-07-10
- 0.0.4 — 2016-07-10
- 0.0.3 — 2016-07-10
- 0.0.2 — 2016-07-10
- 0.0.1 — 2016-07-10

## README

# feed-mixer

feed-mixer is a module which transforms multiple rss/atom feeds into 
a single rss/atom feed.

It can be a single method use module or it can poll data every so often.

[Here is an example](https://github.com/AaronAcerboni/feed-mixer-server-example) 
of it being used in the context of a server.

```
npm install feed-mixer
```

# usage

```javascript
var FeedMixer = require('feed-mixer');

var mixer = new FeedMixer({
    "title": "My aggregate feed",
    "description": "This feed is made up of many.",
    "link": "http://example.com",
    "output": "rss-2.0",
    "feeds": [
        "https://www.youtube.com/feeds/videos.xml?user=vsauce",
        "https://twitrss.me/twitter_user_to_rss/?user=tweetsauce"
    ]
});

// Pattern A

mixer.refresh().then(function (feed) {
    require('fs').writeFileSync("output.rss", feed);
});

// OR Pattern B

mixer.on('refreshComplete', function (feed) {
    require('fs').writeFileSync("output.rss", feed);
});

mixer.refresh();
```

### API

#### FeedMixer(config)

Returns a FeedMixer object

```javascript
var mixer = new FeedMixer({
    "title": "My aggregate feed",
    "description": "This feed is made up of many.",
    "link": "http://example.com",
    "output": "rss-2.0",
    "update": "00:30:00",
    "feeds": [
        "https://www.youtube.com/feeds/videos.xml?user=vsauce",
        "https://twitrss.me/twitter_user_to_rss/?user=tweetsauce"
    ]
})
```


#### FeedMixer(configSource)

Returns a FeedMixer object with a config specified to JSON source.

```javascript
var mixer = new FeedMixer('./config.json')
```

#### FeedMixer.refresh()

Returns a promise of which the callback argument is a string of the 
aggregate feed.

This function works by requesting all the feeds specified in the url and 
then aggregating them into one feed.

```javascript
mixer.refresh().then(function (feed) {
    require('fs').writeFileSync('aggregate.rss', feed);
});
```

#### FeedMixer.aggregate

Returns a traversable object of the aggregate feed in the format of the 
[feed](https://github.com/jpmonette/feed) module.

```javascript
mixer.aggregate.length
```

#### FeedMixer.getFeed(feedFormatType)

Returns a string version of the aggregate feed.

`feedFormatType` is either `"rss-2.0"` or `"atom-1.0"`.
Defaults to the config output type.

```javascript
var feedString = mixer.getFeed('atom-1.0');
```

#### FeedMixer.end()
#### FeedMixer.finish()

Stop the automatic polling/refreshing of the aggregate feed.

```javascript
mixer.end();
```


### config options

Config is either supplied in the constructor argument or as a 
resource string to a JSON file.

```
{
    name:        Your aggregate feed name
    description: Your aggregate feed description
    link:        Your aggregate feed url
    output:      Your aggregate feed in "rss-2.0" or "atom-1.0" format
    update:      (Optional) How often to refresh (hh:mm:ss format)
}
```

### Events
#### FeedMixer.events.on('refreshStart')

Event called when the `refresh()` method is called. 
Argument passed is the `Date` of refresh.

```javascript
mixer.events.on('refreshStart', function (when) {
    console.log('Started fetching/aggregating at ', when);
});
```

#### FeedMixer.events.on('refreshCompleted')

Event called when aggregate feed is ready and `FeedMixer.aggregate` 
property is updated.

Argument passed is the string of the aggregate feed in either the 
rss or atom format.

```javascript
var latestFeedVersion;

mixer.events.on('refreshComplete', function (feed) {
    latestFeedVersion = feed;
});
```

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