Skip to content
/ tmdb Public
forked from gajus/tmdb

The Movie Database (TMDb) SDK.

Notifications You must be signed in to change notification settings

minima/tmdb

 
 

Repository files navigation

TMDb

GitSpo Mentions Travis build status Coveralls NPM version Canonical Code Style Twitter Follow

The Movie Database (TMDb) SDK.

Features

  • Automatic rate-throttling
  • Strict types

Usage

import {
  Tmdb
} from 'tmdb';

/**
 * @see https://developers.themoviedb.org/3/getting-started/authentication
 */
const apiKey: string = '';

const tmdb = new Tmdb(apiKey);

API

Refer to the source code and the type definitions.

Note: Only a subset of the API is implemented. I will be adding new methods as needed. If you need a method added, raise a PR. Alternatively, you can use the low-level get method to construct any API calls.

Handling errors

Methods that are expected to return a specific resource will throw NotFoundError if the resource is not found.

import {
  Tmdb,
  NotFoundError
} from 'tmdb';

const tmdb = new Tmdb([..]);

try {
  await tmdb.getMovie(1);
} catch (error) {
  if (error instanceof NotFoundError) {
    console.error('Movie TMDb ID #1 not found.');
  } else {
    throw error;
  }
}

Logging

This package is using roarr logger to log the program's state.

Export ROARR_LOG=true environment variable to enable log printing to stdout.

Use roarr-cli program to pretty-print the logs.

About

The Movie Database (TMDb) SDK.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%