Constructor
new TmdbClient(apiKey, language)
Sets properties.
- Source:
Parameters:
Name | Type | Default | Description |
---|---|---|---|
apiKey |
string
|
The TMDb API key. | |
language |
string
|
en-US | The natural language of queries, the default is "en-US". |
Methods
getAccountSection() → {exports.AccountSection}
Gets an AccountSection instance which can
be used to get and handle account data.
- Source:
Returns:
- Type:
-
exports.AccountSection
An AccountSection instance.
getAuthenticator() → {exports.Authenticator}
Gets an Authenticator instance which can
be used to handle TMDb authentications.
- Source:
Returns:
- Type:
-
exports.Authenticator
An Authenticator instance.
getCollectionSection() → {exports.CollectionSection}
Gets a CollectionSection instance which can
be used to get collection data.
- Source:
Returns:
- Type:
-
exports.CollectionSection
A CollectionSection instance.
getCompanySection() → {exports.CompanySection}
Gets a CompanySection instance which can
be used to get company data.
- Source:
Returns:
- Type:
-
exports.CompanySection
A CompanySection instance.
getConfigurationSection() → {exports.ConfigurationSection}
Gets a ConfigurationSection instance which can
be used to get TMDb configuration data.
- Source:
Returns:
- Type:
-
exports.ConfigurationSection
A ConfigurationSection instance.
getCreditSection() → {exports.CreditSection}
Gets a CreditSection instance which can
be used to get credit data.
- Source:
Returns:
- Type:
-
exports.CreditSection
A CreditSection instance.
getDiscoverSection() → {exports.DiscoverSection}
Gets a DiscoverSection instance which can
be used to discover media data on TMDb.
- Source:
Returns:
- Type:
-
exports.DiscoverSection
A DiscoverSection instance.
getFindSection(externalSource) → {exports.FindSection}
Gets a FindSection instance which can
be used to find media data based on external
source IDs via TMDb.
- Source:
Parameters:
Name | Type | Description |
---|---|---|
externalSource |
The external source (see tmdb_utils.externalSources). |
Returns:
- Type:
-
exports.FindSection
A FindSection instance based on the passed external source.
getGenreSection() → {exports.GenreSection}
Gets a GenreSection instance which can be used
to get genre data.
- Source:
Returns:
- Type:
-
exports.GenreSection
A GenreSection instance.
getGuestSessionSection() → {exports.GuestSessionSection}
Gets a GuestSessionSection which can be used
to get guest session data.
- Source:
Returns:
- Type:
-
exports.GuestSessionSection
A GuestSessionSection instance.
getKeywordSection() → {exports.KeywordSection}
Gets a KeywordSection instance which can be used
to get keyword data.
- Source:
Returns:
- Type:
-
exports.KeywordSection
A KeywordSection instance.
getListSection() → {exports.ListSection}
Gets a ListSection instance which can be used
to get and handle list data.
- Source:
Returns:
- Type:
-
exports.ListSection
A ListSection instance.
getMovieSection() → {exports.MovieSection}
Gets a MovieSection instance which can be used
to handle and get movie data on TMDb.
- Source:
Returns:
- Type:
-
exports.MovieSection
A MovieSection instance.
getNetworkSection() → {exports.NetworkSection}
Gets a NetworkSection instance which can be used to get network data.
- Source:
Returns:
- Type:
-
exports.NetworkSection
A NetworkSection instance.
getPeopleSection() → {exports.PeopleSection}
Gets a PeopleSection instance which can be used
to get data about people.
- Source:
Returns:
- Type:
-
exports.PeopleSection
A PeopleSection instance.
getReviewSection() → {exports.ReviewSection}
Gets a ReviewSection instance which can be used to get review data.
- Source:
Returns:
- Type:
-
exports.ReviewSection
A ReviewSection instance.
getSearchSection() → {exports.SearchSection}
Gets a SearchSection instance which can be used to search TMDb.
- Source:
Returns:
- Type:
-
exports.SearchSection
A SearchSection instance.
getTrendingSection(timeWindow) → {exports.TrendingSection}
Gets a TrendingSection which can be used to get trending media from TMDb.
- Source:
Parameters:
Name | Type | Description |
---|---|---|
timeWindow |
string
|
The time window (see tmdb_utils.timeWindows). |
Returns:
- Type:
-
exports.TrendingSection
A TrendingSection instance based on the passed time window.
getTvShowSection() → {exports.TvShowSection}
Gets a TvShowSection instance which can be used
to handle and get TV show data on TMDb.
- Source:
Returns:
- Type:
-
exports.TvShowSection
A TvShowSection instance.
getWatchProvidersSection() → {exports.WatchProvidersSection}
Gets a WatchProvidersSection instance which can be used
to get watch provider data from TMDb.
- Source:
Returns:
- Type:
-
exports.WatchProvidersSection
A WatchProvidersSection instance.