Git Product home page Git Product logo

rss-feed-emitter's Introduction

RSS Feed Emitter

Known Vulnerabilities

Track tons of feeds and receive events for every new item published with this super RSS News Feed aggregator.

Tutorial

This is a fully functional module, but its source code and repository are also a super complete tutorial, covering:

  1. What to do first when creating a module from scratch
  2. How to manage your module in Github and npm
  3. How to transpile your ES6 code into ES5
  4. How to create automated unit and integration tests
  5. How to integrate them with Travis CI and make the build break if tests didn't pass
  6. How to automatically test your module against various versions of Node.js
  7. How to setup a code coverage tool and keep 100% coverage
  8. How to integrate the coverage results with Code Climate
  9. How to configure linting tools to make your code base consistent
  10. How to deploy to Github and npm with tags and releases

If you're afraid to read the source code of the modules you use or to create your first module, this is the best chance you have to break this barrier :)

Start here

Features

  • Supports Node.js 4.x, 5.x, 6.x, 7.x, 8.x, 9.x, 10.x, 11.x and @stable
  • Supported Node.js 0.10.x and 0.12.x until rss-feed-emmiter version 1.0.7
  • 100% code coverage with unit and integration tests
  • Simple interface
  • Automatically manages feed history memory
  • Written in ES6
  • Special thanks to @TobiTenno for the complete rewrite!

Usage

Install

$ npm install rss-feed-emitter

Creating an instance

let RssFeedEmitter = require('rss-feed-emitter');
let feeder = new RssFeedEmitter();

Changing the user agent for requests

let feeder = new RssFeedEmitter({ userAgent: 'Your UA string' });

Adding feeds

feeder.add({
  url: 'http://www.nintendolife.com/feeds/news',
  refresh: 2000
});

Default refresh value is 60 seconds

Listening to new items

feeder.on('new-item', function(item) {
  console.log(item);
})

Listing all feeds in the instance

feeder.list();

Removing a single feed

feeder.remove('http://www.nintendolife.com/feeds/news');

Destroying feed instance

feeder.destroy();

This will remove all feeds from the instance

Contributors


@TobiTenno

Author


@filipedeschamps

rss-feed-emitter's People

Contributors

filipedeschamps avatar ardakilic avatar joakimbeng avatar ga2mer avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.