๐Ÿฟ @lorenzopant/tmdb

Images

Shared image types used across company, network, movie, TV, and person endpoints.

These types are shared across multiple API namespaces that return image data. Rather than duplicating definitions, they are centralised here and referenced throughout the API reference.

Core Types


ImageItem

Metadata for a single image asset. Used as the element type for all image collections returned by TMDB image endpoints.

Prop

Type


OrganizationImage

Metadata for a single image asset. Used as the element type for company and network image collections. Slightly different from ImageItem as it includes fewer properties.

Prop

Type


FileType

A union of all valid file types returned by TMDB image endpoints.

type FileType = ".png" | ".svg";

or string if you want, made available via LiteralUnion interally.


ImageCollectionKey

A union of all valid image collection keys returned by TMDB image endpoints.

type ImageCollectionKey = "backdrops" | "logos" | "posters" | "profiles" | "stills";

ImagesResult<T, K>

A generic image result type. Use the type parameter to specify which image collectionsare present in the response for a given entity type.

Prop

Type

Example

export type MovieImages = ImagesResult<ImageItem, "backdrops" | "logos" | "posters">;

export type TVSeriesImages = ImagesResult<TVImageItem, "backdrops" | "logos" | "posters">;

export type CompanyImages = ImagesResult<OrganizationImage, "logos">;

On this page