@openstapps/feed-importer

@openstapps/feed-importer

It's a library (npm package) which makes fetching data of an Atom or RSS feed easier.

In it's core, this is a wrapper for Atom/RSS parsing library feedparser.

Compared to feedparser, this libary is much simpler to use, in a sense that a developer just needs to provide the URL of a feed, and he is already able to get that feeds items as an array of JavaScript objects.

Installation

It's installed easily via npm:

npm install @openstapps/feed-importer

Use

After FeedImporter class is imported, e.g.:

import {FeedImporter} from '@openstapps/feed-importer';

an object needs to be created, and afterwards we are ready to use its getItems method:

const feedImporter = new FeedImporter('http://some-url.domain'); // create an object

await feedImporter.getItems();
feedImporter.asObjects();
// do something with the items from the feed

await feedImporter.getItems(['title', 'description']);
// after fetching from the feed, items are filtered to contain only 'title' and 'description' properties

feedImporter.asSCMessages((feedItem: any): SCMessage => { ... });
// optionally transform the feed items to a SCMessage depending on your needs.

Development

If you want to further develop this library or to just see how it works, these are useful commands:

npm install
npm run build

For running tests:

npm run test # or npm test

Changelog

1.0.0 (2020-11-30)

Features

• add feed item transformation option (b1cc3a4)