@lorenzopant/tmdb 1.14.1 → 1.15.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +0 -1
- package/dist/client.js +2 -7
- package/dist/endpoints/base.d.ts +0 -1
- package/dist/endpoints/certifications.d.ts +0 -1
- package/dist/endpoints/changes.d.ts +0 -1
- package/dist/endpoints/collections.d.ts +0 -1
- package/dist/endpoints/companies.d.ts +0 -1
- package/dist/endpoints/configuration.d.ts +0 -1
- package/dist/endpoints/credits.d.ts +0 -1
- package/dist/endpoints/discover.d.ts +0 -1
- package/dist/endpoints/find.d.ts +0 -1
- package/dist/endpoints/genres.d.ts +0 -1
- package/dist/endpoints/keywords.d.ts +0 -1
- package/dist/endpoints/movie_lists.d.ts +0 -1
- package/dist/endpoints/movies.d.ts +0 -1
- package/dist/endpoints/networks.d.ts +0 -1
- package/dist/endpoints/search.d.ts +0 -1
- package/dist/endpoints/trending.d.ts +36 -0
- package/dist/endpoints/trending.js +48 -0
- package/dist/endpoints/tv_episode_groups.d.ts +0 -1
- package/dist/endpoints/tv_episodes.d.ts +0 -1
- package/dist/endpoints/tv_seasons.d.ts +0 -1
- package/dist/endpoints/tv_series.d.ts +0 -1
- package/dist/endpoints/tv_series_lists.d.ts +0 -1
- package/dist/endpoints/watch_providers.d.ts +0 -1
- package/dist/errors/messages.d.ts +0 -1
- package/dist/errors/tmdb.d.ts +0 -1
- package/dist/images/images.d.ts +0 -1
- package/dist/index.d.ts +0 -1
- package/dist/routes.d.ts +6 -1
- package/dist/routes.js +6 -0
- package/dist/tmdb.d.ts +2 -1
- package/dist/tmdb.js +3 -0
- package/dist/types/collections.d.ts +0 -1
- package/dist/types/common/certifications.d.ts +0 -1
- package/dist/types/common/changes.d.ts +0 -1
- package/dist/types/common/images.d.ts +0 -1
- package/dist/types/common/index.d.ts +0 -1
- package/dist/types/common/media.d.ts +0 -1
- package/dist/types/common/pagination.d.ts +0 -1
- package/dist/types/common/params.d.ts +0 -1
- package/dist/types/companies.d.ts +0 -1
- package/dist/types/config/configuration.d.ts +0 -1
- package/dist/types/config/countries.d.ts +0 -1
- package/dist/types/config/images.d.ts +0 -1
- package/dist/types/config/index.d.ts +0 -1
- package/dist/types/config/languages.d.ts +0 -1
- package/dist/types/config/options.d.ts +0 -1
- package/dist/types/config/timezones.d.ts +0 -1
- package/dist/types/credits.d.ts +0 -1
- package/dist/types/discover.d.ts +0 -1
- package/dist/types/enums.d.ts +0 -1
- package/dist/types/find.d.ts +0 -1
- package/dist/types/index.d.ts +1 -1
- package/dist/types/index.js +1 -0
- package/dist/types/keywords.d.ts +0 -1
- package/dist/types/movies.d.ts +0 -1
- package/dist/types/networks.d.ts +0 -1
- package/dist/types/search.d.ts +0 -1
- package/dist/types/trending.d.ts +55 -0
- package/dist/types/trending.js +1 -0
- package/dist/types/tv-episode-groups.d.ts +0 -1
- package/dist/types/tv-episodes.d.ts +0 -1
- package/dist/types/tv-seasons.d.ts +0 -1
- package/dist/types/tv-series.d.ts +0 -1
- package/dist/types/utility.d.ts +0 -1
- package/dist/types/watch-providers.d.ts +0 -1
- package/dist/utils/index.d.ts +0 -1
- package/dist/utils/logger.d.ts +0 -1
- package/dist/utils/logger.js +2 -3
- package/package.json +6 -2
- package/.release-it.json +0 -18
- package/dist/client.d.ts.map +0 -1
- package/dist/endpoints/base.d.ts.map +0 -1
- package/dist/endpoints/certifications.d.ts.map +0 -1
- package/dist/endpoints/changes.d.ts.map +0 -1
- package/dist/endpoints/collections.d.ts.map +0 -1
- package/dist/endpoints/companies.d.ts.map +0 -1
- package/dist/endpoints/configuration.d.ts.map +0 -1
- package/dist/endpoints/credits.d.ts.map +0 -1
- package/dist/endpoints/discover.d.ts.map +0 -1
- package/dist/endpoints/find.d.ts.map +0 -1
- package/dist/endpoints/genres.d.ts.map +0 -1
- package/dist/endpoints/keywords.d.ts.map +0 -1
- package/dist/endpoints/movie_lists.d.ts.map +0 -1
- package/dist/endpoints/movies.d.ts.map +0 -1
- package/dist/endpoints/networks.d.ts.map +0 -1
- package/dist/endpoints/search.d.ts.map +0 -1
- package/dist/endpoints/tv_episode_groups.d.ts.map +0 -1
- package/dist/endpoints/tv_episodes.d.ts.map +0 -1
- package/dist/endpoints/tv_seasons.d.ts.map +0 -1
- package/dist/endpoints/tv_series.d.ts.map +0 -1
- package/dist/endpoints/tv_series_lists.d.ts.map +0 -1
- package/dist/endpoints/watch_providers.d.ts.map +0 -1
- package/dist/errors/messages.d.ts.map +0 -1
- package/dist/errors/tmdb.d.ts.map +0 -1
- package/dist/images/images.d.ts.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/routes.d.ts.map +0 -1
- package/dist/tmdb.d.ts.map +0 -1
- package/dist/types/collections.d.ts.map +0 -1
- package/dist/types/common/certifications.d.ts.map +0 -1
- package/dist/types/common/changes.d.ts.map +0 -1
- package/dist/types/common/images.d.ts.map +0 -1
- package/dist/types/common/index.d.ts.map +0 -1
- package/dist/types/common/media.d.ts.map +0 -1
- package/dist/types/common/pagination.d.ts.map +0 -1
- package/dist/types/common/params.d.ts.map +0 -1
- package/dist/types/companies.d.ts.map +0 -1
- package/dist/types/config/configuration.d.ts.map +0 -1
- package/dist/types/config/countries.d.ts.map +0 -1
- package/dist/types/config/images.d.ts.map +0 -1
- package/dist/types/config/index.d.ts.map +0 -1
- package/dist/types/config/languages.d.ts.map +0 -1
- package/dist/types/config/options.d.ts.map +0 -1
- package/dist/types/config/timezones.d.ts.map +0 -1
- package/dist/types/credits.d.ts.map +0 -1
- package/dist/types/discover.d.ts.map +0 -1
- package/dist/types/enums.d.ts.map +0 -1
- package/dist/types/find.d.ts.map +0 -1
- package/dist/types/index.d.ts.map +0 -1
- package/dist/types/keywords.d.ts.map +0 -1
- package/dist/types/movies.d.ts.map +0 -1
- package/dist/types/networks.d.ts.map +0 -1
- package/dist/types/search.d.ts.map +0 -1
- package/dist/types/tv-episode-groups.d.ts.map +0 -1
- package/dist/types/tv-episodes.d.ts.map +0 -1
- package/dist/types/tv-seasons.d.ts.map +0 -1
- package/dist/types/tv-series.d.ts.map +0 -1
- package/dist/types/utility.d.ts.map +0 -1
- package/dist/types/watch-providers.d.ts.map +0 -1
- package/dist/utils/index.d.ts.map +0 -1
- package/dist/utils/logger.d.ts.map +0 -1
- package/eslint.config.mjs +0 -6
- package/package-scripts.json +0 -0
- package/tsconfig.json +0 -115
- package/vitest.config.mts +0 -16
package/dist/client.d.ts
CHANGED
package/dist/client.js
CHANGED
|
@@ -63,9 +63,6 @@ export class ApiClient {
|
|
|
63
63
|
if (value === null) {
|
|
64
64
|
return undefined;
|
|
65
65
|
}
|
|
66
|
-
if (value === undefined) {
|
|
67
|
-
return undefined;
|
|
68
|
-
}
|
|
69
66
|
if (typeof value !== "object") {
|
|
70
67
|
return value;
|
|
71
68
|
}
|
|
@@ -73,10 +70,8 @@ export class ApiClient {
|
|
|
73
70
|
return value.map((v) => this.sanitizeNulls(v));
|
|
74
71
|
}
|
|
75
72
|
const sanitized = {};
|
|
76
|
-
for (const key
|
|
77
|
-
|
|
78
|
-
sanitized[key] = this.sanitizeNulls(value[key]);
|
|
79
|
-
}
|
|
73
|
+
for (const [key, val] of Object.entries(value)) {
|
|
74
|
+
sanitized[key] = this.sanitizeNulls(val);
|
|
80
75
|
}
|
|
81
76
|
return sanitized;
|
|
82
77
|
}
|
package/dist/endpoints/base.d.ts
CHANGED
package/dist/endpoints/find.d.ts
CHANGED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import type { PaginatedResponse, TrendingAllResult, TrendingMovieResult, TrendingParams, TrendingPersonResult, TrendingTVResult } from "../types";
|
|
2
|
+
import { TMDBAPIBase } from "./base";
|
|
3
|
+
export declare class TrendingAPI extends TMDBAPIBase {
|
|
4
|
+
/**
|
|
5
|
+
* Trending All
|
|
6
|
+
* GET - https://api.themoviedb.org/3/trending/all/{time_window}
|
|
7
|
+
*
|
|
8
|
+
* Get the trending movies, TV shows and people on TMDB.
|
|
9
|
+
* @reference https://developer.themoviedb.org/reference/trending-all
|
|
10
|
+
*/
|
|
11
|
+
all(params: TrendingParams): Promise<PaginatedResponse<TrendingAllResult>>;
|
|
12
|
+
/**
|
|
13
|
+
* Trending Movies
|
|
14
|
+
* GET - https://api.themoviedb.org/3/trending/movie/{time_window}
|
|
15
|
+
*
|
|
16
|
+
* Get the trending movies on TMDB.
|
|
17
|
+
* @reference https://developer.themoviedb.org/reference/trending-movies
|
|
18
|
+
*/
|
|
19
|
+
movies(params: TrendingParams): Promise<PaginatedResponse<TrendingMovieResult>>;
|
|
20
|
+
/**
|
|
21
|
+
* Trending TV
|
|
22
|
+
* GET - https://api.themoviedb.org/3/trending/tv/{time_window}
|
|
23
|
+
*
|
|
24
|
+
* Get the trending TV shows on TMDB.
|
|
25
|
+
* @reference https://developer.themoviedb.org/reference/trending-tv
|
|
26
|
+
*/
|
|
27
|
+
tv(params: TrendingParams): Promise<PaginatedResponse<TrendingTVResult>>;
|
|
28
|
+
/**
|
|
29
|
+
* Trending People
|
|
30
|
+
* GET - https://api.themoviedb.org/3/trending/person/{time_window}
|
|
31
|
+
*
|
|
32
|
+
* Get the trending people on TMDB.
|
|
33
|
+
* @reference https://developer.themoviedb.org/reference/trending-people
|
|
34
|
+
*/
|
|
35
|
+
people(params: TrendingParams): Promise<PaginatedResponse<TrendingPersonResult>>;
|
|
36
|
+
}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import { ENDPOINTS } from "../routes";
|
|
2
|
+
import { TMDBAPIBase } from "./base";
|
|
3
|
+
export class TrendingAPI extends TMDBAPIBase {
|
|
4
|
+
/**
|
|
5
|
+
* Trending All
|
|
6
|
+
* GET - https://api.themoviedb.org/3/trending/all/{time_window}
|
|
7
|
+
*
|
|
8
|
+
* Get the trending movies, TV shows and people on TMDB.
|
|
9
|
+
* @reference https://developer.themoviedb.org/reference/trending-all
|
|
10
|
+
*/
|
|
11
|
+
async all(params) {
|
|
12
|
+
const { time_window, language = this.defaultOptions.language } = params;
|
|
13
|
+
return this.client.request(`${ENDPOINTS.TRENDING.ALL}/${time_window}`, { language });
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Trending Movies
|
|
17
|
+
* GET - https://api.themoviedb.org/3/trending/movie/{time_window}
|
|
18
|
+
*
|
|
19
|
+
* Get the trending movies on TMDB.
|
|
20
|
+
* @reference https://developer.themoviedb.org/reference/trending-movies
|
|
21
|
+
*/
|
|
22
|
+
async movies(params) {
|
|
23
|
+
const { time_window, language = this.defaultOptions.language } = params;
|
|
24
|
+
return this.client.request(`${ENDPOINTS.TRENDING.MOVIE}/${time_window}`, { language });
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Trending TV
|
|
28
|
+
* GET - https://api.themoviedb.org/3/trending/tv/{time_window}
|
|
29
|
+
*
|
|
30
|
+
* Get the trending TV shows on TMDB.
|
|
31
|
+
* @reference https://developer.themoviedb.org/reference/trending-tv
|
|
32
|
+
*/
|
|
33
|
+
async tv(params) {
|
|
34
|
+
const { time_window, language = this.defaultOptions.language } = params;
|
|
35
|
+
return this.client.request(`${ENDPOINTS.TRENDING.TV}/${time_window}`, { language });
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Trending People
|
|
39
|
+
* GET - https://api.themoviedb.org/3/trending/person/{time_window}
|
|
40
|
+
*
|
|
41
|
+
* Get the trending people on TMDB.
|
|
42
|
+
* @reference https://developer.themoviedb.org/reference/trending-people
|
|
43
|
+
*/
|
|
44
|
+
async people(params) {
|
|
45
|
+
const { time_window, language = this.defaultOptions.language } = params;
|
|
46
|
+
return this.client.request(`${ENDPOINTS.TRENDING.PERSON}/${time_window}`, { language });
|
|
47
|
+
}
|
|
48
|
+
}
|
package/dist/errors/tmdb.d.ts
CHANGED
package/dist/images/images.d.ts
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/routes.d.ts
CHANGED
package/dist/routes.js
CHANGED
package/dist/tmdb.d.ts
CHANGED
|
@@ -20,6 +20,7 @@ import { NetworksAPI } from "./endpoints/networks";
|
|
|
20
20
|
import { TVEpisodesAPI } from "./endpoints/tv_episodes";
|
|
21
21
|
import { TVEpisodeGroupsAPI } from "./endpoints/tv_episode_groups";
|
|
22
22
|
import { TVSeasonsAPI } from "./endpoints/tv_seasons";
|
|
23
|
+
import { TrendingAPI } from "./endpoints/trending";
|
|
23
24
|
export declare class TMDB {
|
|
24
25
|
private client;
|
|
25
26
|
private options;
|
|
@@ -44,6 +45,7 @@ export declare class TMDB {
|
|
|
44
45
|
tv_episodes: TVEpisodesAPI;
|
|
45
46
|
tv_episode_groups: TVEpisodeGroupsAPI;
|
|
46
47
|
tv_seasons: TVSeasonsAPI;
|
|
48
|
+
trending: TrendingAPI;
|
|
47
49
|
/**
|
|
48
50
|
* Creates a new TMDB instance.
|
|
49
51
|
* @param accessToken The TMDB API access token.
|
|
@@ -51,4 +53,3 @@ export declare class TMDB {
|
|
|
51
53
|
*/
|
|
52
54
|
constructor(accessToken: string, options?: TMDBOptions);
|
|
53
55
|
}
|
|
54
|
-
//# sourceMappingURL=tmdb.d.ts.map
|
package/dist/tmdb.js
CHANGED
|
@@ -22,6 +22,7 @@ import { NetworksAPI } from "./endpoints/networks";
|
|
|
22
22
|
import { TVEpisodesAPI } from "./endpoints/tv_episodes";
|
|
23
23
|
import { TVEpisodeGroupsAPI } from "./endpoints/tv_episode_groups";
|
|
24
24
|
import { TVSeasonsAPI } from "./endpoints/tv_seasons";
|
|
25
|
+
import { TrendingAPI } from "./endpoints/trending";
|
|
25
26
|
export class TMDB {
|
|
26
27
|
client;
|
|
27
28
|
options; // ** Default options for all requests
|
|
@@ -46,6 +47,7 @@ export class TMDB {
|
|
|
46
47
|
tv_episodes;
|
|
47
48
|
tv_episode_groups;
|
|
48
49
|
tv_seasons;
|
|
50
|
+
trending;
|
|
49
51
|
// etc...
|
|
50
52
|
/**
|
|
51
53
|
* Creates a new TMDB instance.
|
|
@@ -78,5 +80,6 @@ export class TMDB {
|
|
|
78
80
|
this.tv_episodes = new TVEpisodesAPI(this.client, this.options);
|
|
79
81
|
this.tv_episode_groups = new TVEpisodeGroupsAPI(this.client, this.options);
|
|
80
82
|
this.tv_seasons = new TVSeasonsAPI(this.client, this.options);
|
|
83
|
+
this.trending = new TrendingAPI(this.client, this.options);
|
|
81
84
|
}
|
|
82
85
|
}
|
|
@@ -1,4 +1,3 @@
|
|
|
1
1
|
import { ConfigurationCountry } from "./configuration";
|
|
2
2
|
export declare const TMDBCountries: ConfigurationCountry[];
|
|
3
3
|
export type CountryISO3166_1 = "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AN" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BM" | "BN" | "BO" | "BR" | "BS" | "BT" | "BU" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CS" | "CU" | "CV" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SU" | "SV" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TP" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XC" | "XG" | "XI" | "XK" | "YE" | "YT" | "YU" | "ZA" | "ZM" | "ZR" | "ZW";
|
|
4
|
-
//# sourceMappingURL=countries.d.ts.map
|
|
@@ -9,4 +9,3 @@ export type PrimaryTranslations = "af-ZA" | "ar-AE" | "ar-SA" | "be-BY" | "bg-BG
|
|
|
9
9
|
* https://developer.themoviedb.org/reference/configuration-primary-translations
|
|
10
10
|
*/
|
|
11
11
|
export type Language = PrimaryTranslations | LanguageISO6391;
|
|
12
|
-
//# sourceMappingURL=languages.d.ts.map
|
package/dist/types/credits.d.ts
CHANGED
package/dist/types/discover.d.ts
CHANGED
package/dist/types/enums.d.ts
CHANGED
package/dist/types/find.d.ts
CHANGED
package/dist/types/index.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export * from "./common";
|
|
2
2
|
export * from "./config";
|
|
3
3
|
export * from "./discover";
|
|
4
|
+
export * from "./trending";
|
|
4
5
|
export * from "./movies";
|
|
5
6
|
export * from "./search";
|
|
6
7
|
export * from "./tv-series";
|
|
@@ -15,4 +16,3 @@ export * from "./find";
|
|
|
15
16
|
export * from "./watch-providers";
|
|
16
17
|
export * from "./keywords";
|
|
17
18
|
export * from "./credits";
|
|
18
|
-
//# sourceMappingURL=index.d.ts.map
|
package/dist/types/index.js
CHANGED
package/dist/types/keywords.d.ts
CHANGED
package/dist/types/movies.d.ts
CHANGED
package/dist/types/networks.d.ts
CHANGED
package/dist/types/search.d.ts
CHANGED
|
@@ -196,4 +196,3 @@ export type SearchTVSeriesParams = {
|
|
|
196
196
|
* Parameters for multi-search (movies, TV shows, and people in a single request)
|
|
197
197
|
*/
|
|
198
198
|
export type SearchMultiParams = Pick<SearchTVSeriesParams, "query" | "include_adult" | "language" | "page">;
|
|
199
|
-
//# sourceMappingURL=search.d.ts.map
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import type { Language } from "./config/languages";
|
|
2
|
+
import type { MovieResultItem, PersonResultItem, TVSeriesResultItem } from "./search";
|
|
3
|
+
/** Time window for trending data */
|
|
4
|
+
export type TrendingTimeWindow = "day" | "week";
|
|
5
|
+
/**
|
|
6
|
+
* Query parameters for all trending endpoints.
|
|
7
|
+
* `time_window` is embedded in the URL path; `language` is a query param.
|
|
8
|
+
*/
|
|
9
|
+
export type TrendingParams = {
|
|
10
|
+
/** Time window for trending data. `"day"` returns the last 24 hours, `"week"` returns the last 7 days. */
|
|
11
|
+
time_window: TrendingTimeWindow;
|
|
12
|
+
/** Language for localised results (ISO 639-1 + ISO 3166-1, e.g. `"en-US"`). */
|
|
13
|
+
language?: Language;
|
|
14
|
+
};
|
|
15
|
+
/**
|
|
16
|
+
* A trending movie result.
|
|
17
|
+
* Extends {@link MovieResultItem} with the `media_type` discriminator.
|
|
18
|
+
*/
|
|
19
|
+
export type TrendingMovieResult = MovieResultItem & {
|
|
20
|
+
/** Media type discriminator — always `"movie"` for this endpoint. */
|
|
21
|
+
media_type: "movie";
|
|
22
|
+
};
|
|
23
|
+
/**
|
|
24
|
+
* A trending TV series result.
|
|
25
|
+
* Extends {@link TVSeriesResultItem} with the `media_type` discriminator.
|
|
26
|
+
*/
|
|
27
|
+
export type TrendingTVResult = TVSeriesResultItem & {
|
|
28
|
+
/** Media type discriminator — always `"tv"` for this endpoint. */
|
|
29
|
+
media_type: "tv";
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* A trending person result.
|
|
33
|
+
* Extends {@link PersonResultItem} with the `media_type` discriminator.
|
|
34
|
+
*/
|
|
35
|
+
export type TrendingPersonResult = PersonResultItem & {
|
|
36
|
+
/** Media type discriminator — always `"person"` for this endpoint. */
|
|
37
|
+
media_type: "person";
|
|
38
|
+
};
|
|
39
|
+
/**
|
|
40
|
+
* Union of all trending result types returned by the `trending.all()` endpoint.
|
|
41
|
+
* Discriminated by `media_type`.
|
|
42
|
+
*
|
|
43
|
+
* @example
|
|
44
|
+
* ```ts
|
|
45
|
+
* import { isTrendingMovie, isTrendingTV } from "@lorenzopant/tmdb";
|
|
46
|
+
*
|
|
47
|
+
* const results = await tmdb.trending.all({ time_window: "day" });
|
|
48
|
+
* for (const item of results.results) {
|
|
49
|
+
* if (item.media_type === "movie") console.log(item.title);
|
|
50
|
+
* if (item.media_type === "tv") console.log(item.name);
|
|
51
|
+
* if (item.media_type === "person") console.log(item.name);
|
|
52
|
+
* }
|
|
53
|
+
* ```
|
|
54
|
+
*/
|
|
55
|
+
export type TrendingAllResult = TrendingMovieResult | TrendingTVResult | TrendingPersonResult;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -129,4 +129,3 @@ export type TVSeasonVideosParams = TVSeasonBaseParams & WithLanguage & {
|
|
|
129
129
|
export type TVSeasonWatchProvidersParams = TVSeasonBaseParams & WithLanguage;
|
|
130
130
|
/** Parameters for the season changes endpoint. */
|
|
131
131
|
export type TVSeasonChangesParams = TVSeasonId & Prettify<WithParams<"page"> & DateRange>;
|
|
132
|
-
//# sourceMappingURL=tv-seasons.d.ts.map
|
package/dist/types/utility.d.ts
CHANGED
|
@@ -14,4 +14,3 @@ export type LiteralUnion<T extends string> = T | (string & {});
|
|
|
14
14
|
*/
|
|
15
15
|
export declare function isKnownForMovie(item: KnownForItem): item is KnownForMovie;
|
|
16
16
|
export declare function isKnownForTV(item: KnownForItem): item is KnownForTV;
|
|
17
|
-
//# sourceMappingURL=utility.d.ts.map
|
package/dist/utils/index.d.ts
CHANGED