1.0.0 • Published 3 years ago

tvdb-v4 v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

The TVDB v4 API

Build Status Coverage Status

A feature-complete library for interfacing with The TVDB's new v4 API. Highlights of the module are described below:

  • The TVDB v4 API
  • Feature-complete
  • Promise-based API
  • No external dependencies
  • Native TypeScript support

Install

$ npm install tvdb-api

Usage

TypeScript

import TVDB from "tvdb-api";

// Create a new instance of the interface
let tvdb = new TVDB("API-KEY");

// Login using a user's PIN
tvdb.login("PIN").then(() => {
	console.log("Login successful");
});

Documentation WIP

While documentation is currently work in progress, all functions are documented and visible within the main interface class here.

The full documentation of The TVDB's v4 API is available here.