🍿 @lorenzopant/tmdb

Details

Get the details of a TV episode.

Get the details of a TV episode by series, season, and episode number. Supports appending sub-resources in a single request via append_to_response.

async details<T extends readonly TVEpisodeAppendToResponseNamespace[] = []>(
  params: TVEpisodeDetailsParams & { append_to_response?: T }
): Promise<T extends [] ? TVEpisode : TVEpisodeDetailsWithAppends<T>>

TMDB Reference: TV Episode Details

Parameters

NameTypeRequiredDescription
series_idnumberTMDB TV series identifier.
season_numbernumberSeason number within the TV series.
episode_numbernumberEpisode number within the season.
append_to_responseTVEpisodeAppendToResponseNamespace[]Sub-resources to append to the response.
languageLanguageLanguage for localized results. Defaults to en-US.

Returns

TVEpisode when no appends are provided, or TVEpisodeDetailsWithAppends<T> when append_to_response is specified.

Example

// Basic details
const episode = await tmdb.tv_episodes.details({
	series_id: 1396,
	season_number: 1,
	episode_number: 1,
});
console.log(episode.name);

// With appended data
const episode = await tmdb.tv_episodes.details({
	series_id: 1396,
	season_number: 1,
	episode_number: 1,
	append_to_response: ["credits", "images", "videos"],
});
console.log(episode.credits.cast);
console.log(episode.videos.results);

Types

On this page