sjaakiejj / node-tvdb

Node.js library for accessing TheTVDB API

node-tvdb

Node.js library for accessing TheTVDB API. Refactored from joaocampinhos/thetvdb-api to give nicer output and lots of additional features.

Pull requests are always very welcome.

Features

• Handle errors from API as JavaScript errors
• Only returns relevant data (no need to call response.Data.Series etc.)
• Set language at initialisation or afterwards when needed
• Normalised keys and values
• Empty values parsed as null
• Updates endpoint grouped by type
• Supports both node callback functions and promises
• Utility function to parse TheTVDB API's pipe list (e.g. "|Name|Name|Name|Name|")
• Tests with Mocha and Wercker CI

Installation

Install with npm:

npm install --save node-tvdb

And run tests with Mocha:

TVDB_KEY=[YOUR API KEY HERE] npm test

Mocha is installed as a development dependency; you do not need to install it globally to run the tests.

Example Usage

To start using this library you first need an API key. You can request one here. Then just follow this simple example that fetches all the shows containing "The Simpsons" in the name.

var TVDB = require("node-tvdb");
var tvdb = new TVDB("ABC123");

tvdb.getSeries("The Simpsons", function(err, response) {
    // handle error and response
});

For use with node engines without class/const/let:

var TVDB = require("node-tvdb/compat");
var tvdb = new TVDB("ABC123");

// continue as normal...

API

var client = new Client(API_KEY, [language])

var Client = require("node-tvdb");

var tvdb           = new Client("ABC123"); // lang defaults to "en"
var tvdbPortuguese = new Client("ABC123", "pt");

getTime

tvdb.getTime(function(error, response) {
    // handle error and response
});

OR

tvdb.getTime()
    .then(function(response) { /* handle response */ })
    .catch(function(error) { /* handle error */ });

getSeriesByName

tvdb.getSeriesByName("Breaking Bad", function(error, response) {
    // handle error and response
});

OR

tvdb.getSeriesByName("Breaking Bad")
    .then(function(response) { /* handle response */ })
    .catch(function(error) { /* handle error */ });

getSeriesById

tvdb.getSeriesById(73255, function(error, response) {
    // handle error and response
});

OR

tvdb.getSeriesById(73255)
    .then(function(response) { /* handle response */ })
    .catch(function(error) { /* handle error */ });

getSeriesByRemoteId

tvdb.getSeriesByRemoteId("tt0903747", function(error, response) {
    // handle error and response
});

OR

tvdb.getSeriesByRemoteId("tt0903747")
    .then(function(response) { /* handle response */ })
    .catch(function(error) { /* handle error */ });

Note: node-tvdb automatically selects between remote providers (IMDb and zap2it)

getSeriesAllById

tvdb.getSeriesAllById(73255, function(error, response) {
    // handle error and response
});

OR

tvdb.getSeriesAllById(73255)
    .then(function(response) { /* handle response */ })
    .catch(function(error) { /* handle error */ });

getEpisodeById

tvdb.getEpisodeById(4768125, function(error, response) {
    // handle error and response
});

OR

tvdb.getEpisodeById(4768125)
    .then(function(response) { /* handle response */ })
    .catch(function(error) { /* handle error */ });

getActors

tvdb.getActors(73255, function(error, response) {
    // handle error and response
});

OR

tvdb.getActors(73255)
    .then(function(response) { /* handle response */ })
    .catch(function(error) { /* handle error */ });

getBanners

tvdb.getBanners(73255, function(error, response) {
    // handle error and response
});

OR

tvdb.getBanners(73255)
    .then(function(response) { /* handle response */ })
    .catch(function(error) { /* handle error */ });

getUpdates

tvdb.getUpdates(1400611370, function(error, response) {
    // handle error and response
});

OR

tvdb.getUpdates(1400611370)
    .then(function(response) { /* handle response */ })
    .catch(function(error) { /* handle error */ });

utils.parsePipeList

var list = "|Mos Def|Faune A. Chambers|"; // from a previous api call
var guestStars = Client.utils.parsePipeList(list);

License

The MIT License (MIT)