feedr

Feedr

Feedr takes in a remote feed (regardless of format type) and converts it into JSON data

Install

Node

• Use: require('feedr')
• Install: npm install --save feedr

Usage

// Prepare
var Feedr, feedr, feeds;

// Include the Feedr Class
Feedr = require('feedr').Feedr;

// Create our Feedr instance, we can pass optional configuration if we wanted
feedr = new Feedr();

// Prepare our feeds that we want read
feeds = {
	github: "https://github.com/bevry/feedr/commits/master.atom",
	twitter: "https://api.twitter.com/1/statuses/user_timeline.json?screen_name=balupton&count=20&include_entities=true&include_rts=true"
};

// Read a single feed
feedr.readFeed(feeds.github, {/* optional configuration*/}, function(err, data, headers){
	console.log(err, data, headers);
});

// Read all the feeds together
feedr.readFeeds(feeds, {/* optional configuration*/}, function(err, result){
	console.log(err, result.github, result.twitter);
});

Configuration

Global configuration properties are:

• log defaults to null, log function to use
• tmpPath defaults to system tmp path, the tempory path to cache our feedr results to
• cache defaults to true, whether or not we should use the cache if it is valid
• xml2jsOptions defaults to null, the options to send to xml2js
• requestOptions defaults to null, the options to send to request

Feed configuration properties are:

• url required, the url to fetch
• hash defaults to hash of the url, the hashed url for caching
• name defaults to hash, the name of the feed for use in debugging
• path defaults to tmp feed path, the path to save the file to
• parse defaults to auto detection based on the extension of the url, whether or not to parse the data into a javascript object, can be set to false, true, "xml", "json", "cson", "yaml"
• checkResponse defaults to null, a function accepting response, data, and next to check the response for errors
• xml2jsOptions defaults to global value, the options to send to xml2js
• requestOptions defaults to global value, the options to send to request

History

Discover the change history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

• Benjamin Lupton b@lupton.cc (https://github.com/balupton)

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton b@lupton.cc — view contributions

Become a contributor!

License

Licensed under the incredibly permissive MIT license

Copyright © 2012+ Bevry Pty Ltd us@bevry.me (http://bevry.me)