@tdanks2000/tmdb-wrapper 1.4.0 → 1.6.0
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/README.md +7 -7
- package/dist/index.cjs +233 -127
- package/dist/index.d.cts +201 -377
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.mts +201 -377
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +233 -128
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -196,7 +196,7 @@ The wrapper also provides access to these additional endpoints:
|
|
|
196
196
|
|
|
197
197
|
The wrapper includes utilities to reliably construct TMDB image URLs, plus a convenience helper for TMDB `Image` objects.
|
|
198
198
|
|
|
199
|
-
```
|
|
199
|
+
```typescript
|
|
200
200
|
import {
|
|
201
201
|
formImage,
|
|
202
202
|
getFullImagePath,
|
|
@@ -207,7 +207,7 @@ import {
|
|
|
207
207
|
|
|
208
208
|
### `getFullImagePath(...)`
|
|
209
209
|
|
|
210
|
-
```
|
|
210
|
+
```typescript
|
|
211
211
|
getFullImagePath(
|
|
212
212
|
baseUrl: string, // e.g. "https://image.tmdb.org/t/p/"
|
|
213
213
|
fileSize: string, // e.g. ImageSizes.W500 or "w780"
|
|
@@ -226,7 +226,7 @@ Notes:
|
|
|
226
226
|
|
|
227
227
|
`formImage` is a small helper that reads `file_path` from a TMDB `Image` object and returns a ready-to-use URL. If the image object doesn’t include a `file_path`, it returns `undefined`.
|
|
228
228
|
|
|
229
|
-
```
|
|
229
|
+
```typescript
|
|
230
230
|
formImage(
|
|
231
231
|
image: Image,
|
|
232
232
|
fileSize: ImageSizes,
|
|
@@ -238,7 +238,7 @@ formImage(
|
|
|
238
238
|
|
|
239
239
|
Poster path without extension (add one via `format`):
|
|
240
240
|
|
|
241
|
-
```
|
|
241
|
+
```typescript
|
|
242
242
|
const posterUrl = getFullImagePath(
|
|
243
243
|
"https://image.tmdb.org/t/p/",
|
|
244
244
|
ImageSizes.W500,
|
|
@@ -250,7 +250,7 @@ const posterUrl = getFullImagePath(
|
|
|
250
250
|
|
|
251
251
|
Profile path that already includes an extension (no need to pass `format`):
|
|
252
252
|
|
|
253
|
-
```
|
|
253
|
+
```typescript
|
|
254
254
|
const profileUrl = getFullImagePath(
|
|
255
255
|
"https://image.tmdb.org/t/p/",
|
|
256
256
|
ImageSizes.W185,
|
|
@@ -261,7 +261,7 @@ const profileUrl = getFullImagePath(
|
|
|
261
261
|
|
|
262
262
|
Using `formImage` with a TMDB response image object:
|
|
263
263
|
|
|
264
|
-
```
|
|
264
|
+
```typescript
|
|
265
265
|
const images = await tmdb.movies.getImages(550);
|
|
266
266
|
const poster = images.posters[0];
|
|
267
267
|
|
|
@@ -271,7 +271,7 @@ const posterUrl = formImage(poster, ImageSizes.W500);
|
|
|
271
271
|
|
|
272
272
|
Override the output extension (append/replace) with `format`:
|
|
273
273
|
|
|
274
|
-
```
|
|
274
|
+
```typescript
|
|
275
275
|
const posterPngUrl = formImage(poster, ImageSizes.W500, ImageFormats.PNG);
|
|
276
276
|
```
|
|
277
277
|
|