🍿 @lorenzopant/tmdb

Details

Get the details of a TV season.

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

async details<T extends readonly TVSeasonAppendToResponseNamespace[] = []>(
  params: TVSeasonDetailsParams & { append_to_response?: T }
): Promise<T extends [] ? TVSeason : TVSeasonDetailsWithAppends<T>>

TMDB Reference: TV Season Details

Parameters

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

Returns

TVSeason when no appends are provided, or TVSeasonDetailsWithAppends<T> when append_to_response is specified.

Example

// Basic details
const season = await tmdb.tv_seasons.details({
	series_id: 1396,
	season_number: 1,
});
console.log(season.name);
console.log(season.episodes.length);

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

Types

On this page