Giter VIP home page Giter VIP logo

node-rss-watcher's Introduction

rss-watcher Build StatusCoverage Status

NPM

gyazo

What is it

RSS-Watcher is Tinu Library/Executable for RSS/Atom Feed Reader

##install

####NPM INSTALL:

npm install rss-watcher

####package.json:

{
  "dependencies":{
    "rss-watcher": "*"
  }
}

Usage

Watcher = require 'rss-watcher'
feed = 'http://github.com/nikezono.atom'

watcher = new Watcher(feed)

watcher.on 'new article',(article)->
  console.log article

watcher.run (err,articles)->
  console.error err if err
  console.log articles # current articles

option

watcher = new Watcher(feed)
watcher.set
  feed:feed # feed url
  interval: 60  # request per interval seconds. default:average update frequency

exposed events

watcher.on "error",(error)->
  console.error error

watcher.on "new article",(article)->
  console.log article # article object

watcher.on "stop", ->
  console.log 'stop'

watcher.stop()

CLI tool

> rss-watcher -f 'http://github.com/nikezono.atom' -i 20000 # 20000s interval

Test

Spec Report:

npm -i -g grunt grunt-cli
grunt test

Coverage dump:

grunt coverage
open coverage.html

node-rss-watcher's People

Contributors

nikezono avatar chi-bd avatar greensopinion avatar arthurbaghdas 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.