nxus-feedreader

Feed Reader Module

Use feedparser to parse and process RSS/Atom feeds.

Installation

> npm install nxus-feedreader --save

Configuration Options

"feed_reader": {
  "interval": 0, // seconds
  "enableQueues": false,
  "enableReadTracking": true,
  "feeds"": {
     name: URL
  }
}

Usage

Register a feed

For each feed to process, register its URL with a identifying name

import {feedreader} from 'nxus-feedreader'

feedreader.feed("my-feed", "https://www....")

Process new/updated items

See the feedreader docs for item fields.

import {feedreader} from 'nxus-feedreader'

feedreader.process("my-feed", (item, meta, ident) => {
  // item and meta are from feedreader, ident is 'my-feed'   
})

You may also process all incoming items regardless of feed

feedreader.process((item, ident) => { })

Fetch feed contents for processing

If interval config is defined (in seconds), feed will automatically be fetched that often. You may manually request a fetch (e.g. on startup or from a user action) by calling fetch

feedreader.fetch()

Run fetch and processing in background worker queues

If you would like fetching and processing to happen in the background, set the enableQueues config or during initialization call:

feedreader.enableQueues()

API

---

FeedReader

Extends HasModels

Feedreader module for parsing and processing RSS/Atom Feeds

_setupTimer

Creates the timer, set to run at the interval specified by config

feed

Register a feed

Parameters

• ident string identifier for this feed
• url string feed URL
• options object tbd (optional, default {})

unfeed

De-register a feed

Parameters

• ident string identifier for this feed

process

Process feed items

Parameters

• ident string? identifier for this feed
• handler function (item, ident) handler function (optional, default null)

fetch

Fetch one or all feeds

Parameters

• ident string? identifier for this feed

enableQueues

Enable queue processing