tvragejson
v0.2.1
Published
A node.js API for the TVRage web services.
Downloads
18
Readme
TV Rage JSON
A node.js API for the TVRage web services; as per the name, all responses are JSON.
Installation
npm install tvragejson
Usage
var TVRage = require("tvragejson");
// Search for a show by name, returning the first match.
TVRage.search("The Big Bang Theory", function(err, response) {
if (!err) {
console.log(response["Results"]["show"][0]);
}
});
// Get information for a particular show - in this case we
// are using the show ID for "The Big Bang Theory".
TVRage.search("8511", function(err, response) {
if (!err) {
console.log(response);
}
});
Supported methods
search
- Search shows by namefullSearch
- Full search for shows by nameshowInfo
- Show info based on a show id that can be acquired viasearch
orfullSearch
fullShowInfo
- Full show info based on a show id that can be acquired viasearch
orfullSearch
episodeList
- Episode list based on a show id that can be acquired via thesearch
orfullSearch
episode_info
- Episode info based on a show id (attainable viasearch
orfullSearch
) and an episode (attainable viaepisodeList
)fullShowList
- Full TV show listfullSchedule
- Full TV schedule based on a two letter country representation as defined by ISO 3166
Contributing
All contributions are welcome, feel free to fork master
, make your changes and open a pull request.
Grunt is used with the JSHint and Watch plugins. To get up and running with grunt you need to do the following:
- Install the Grunt Command Line Interface tools:
npm install -g grunt-cli
- Install the current Grunt version local to this project (so ensure you make this within the project's directory):
npm install grunt --save-dev
Upon making any code changes, make sure you run grunt test
from within the project's directory to verify that there are no errors (this is done using the JSHint plugin mentioned above) - if there are any errors, make all necessary changes before opening a pull request.
Changelog
v0.2.1
- Added xml2js parser config to get back objects, not arrays
- Update dependencies
v0.2.0
- Fix
ECONNRESET
from the TvRage API - The callback now takes two arguments,
err
andresult
- Drop node.js 0.6 support
v0.1.3
- Added a more elaborate .gitignore
v0.1.2
- Added Grunt
v0.1.1
- Added David dependency management badge
License
Licensed under the MIT License