Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

node-tvdb

Build Status npm Downloads

Node.js library for accessing TheTVDB JSON API. Originally based on joaocampinhos/thetvdb-api to give nicer output and 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 on each function call
  • Return values through promises (dropped callback support)
  • Uses the new JSON API from TheTVDB
  • Tests with Mocha and Travis 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.

const TVDB = require('node-tvdb');
const tvdb = new TVDB('ABC123');

tvdb.getSeriesByName('The Simpsons')
    .then(response => { /* process data */ })
    .catch(error => { /* handle error */ });

Full API Docs

Generated API docs with code examples can be found at: edwellbrook.github.io/node-tvdb.

For details on response data, please see TheTVDB API docs.

License

The MIT License (MIT)