got-tmdb
v3.0.1
Published
Easy to use and straightforward module to interact with the TheMovieDatabase API.
Downloads
9
Readme
got-tmdb
Easy to use and straightforward module to interact with the TheMovieDatabase API. Aimed at simplicity, lightweight and low-dependency.
As of version 3.0.1 this package is no longer maintained and it has been replaced by ky-tmdb (identical API, drop-in replacement).
API Key
Generate an API key for your use case. Generating keys can be done here: https://www.themoviedb.org/settings/api
Setup
To initialize the got-TMDB package, construct a new instance
const GotTMDB = require('got-tmdb');
const tmdb = new GotTMDB(options);
Options
apiKey
Set the API key to be used by the module, mandatory field
language
Set the language globally for the TMDB API, by default no language parameter will be sent. Can be overridden in the method's options
adultContent
Set the adult content filtering globally for the TMDB API. By default false (no adult content).
Using this module
Almost all methods described on the API page are implemented (https://developers.themoviedb.org/3/). The TMDB instance contains the following objects:
- Discover
- Find
- Search
- Movies
- TV
- TVSeasons
- TVEpisodes
- Genres
- Companies
- Collections
Those objects will contain the methods as described by the API documentation. For example:
tmdb.TVEpisodes.getDetails('76479', 1, 1);
Changing Language
The language can be set using one of three methods, and must be supplied in either ISO-639-1 or ISO-3166-1 format.
- As option in the GotTMDB constructor, key name is
language
- Using the
tmdb.setLanguage
method - As option in the specific API method, key name is
language
Changing Adult Content Mode
For ease of implementation, a toggle has been added to include/exclude adult content
- As option in the GotTMDB constructor, key name is
adultContent
- Using the
tmdb.setAdultContentMode
method
Changing API Key
The API Key can be set using one of two methods and is required to use this module
- As option in the GotTMDB constructor, key name is
apiKey
- Using the
tmdb.setAPIKey
method