TMDb
The Movie Database (TMDb) SDK.
Features
- Automatic rate-throttling
- Strict types
Usage
; /** * @see https://developers.themoviedb.org/3/getting-started/authentication */const apiKey: string = ''; const 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.
async Promise<number>;async Object;async Promise<MovieType>async Promise<$ReadOnlyArray<MovieBackdropImageType>>;async Promise<$ReadOnlyArray<MovieCastCreditType>>;async Promise<$ReadOnlyArray<MovieCrewCreditType>>;async Promise<$ReadOnlyArray<MoviePosterImageType>>;async Promise<$ReadOnlyArray<MovieVideoType>>;async Promise<PersonType>;
get
get
method is the most primitive TMDb API method and it can be used to construct any of the API queries.
Example: GET /search/movie
API method is not implemented. However, you can still use it as:
await tmdb;
Handling errors
Methods that are expected to return a specific resource will throw NotFoundError
if the resource is not found.
; const tmdb = ; try await tmdb; catch error if error instanceof NotFoundError console; 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.