Skip to main content

Overview

The movie types module contains all TypeScript interfaces and types related to movie data, including detailed movie information, creators, VOD services, premieres, and series data.

CSFDMovie

The main interface representing a complete movie or TV show with all its details.
CSFDMovie
object

CSFDCreators

Organizes all movie creators by their role.
CSFDCreators
object

CSFDMovieCreator

Represents a person involved in movie creation.
CSFDMovieCreator
object

CSFDVod

Video-on-demand service availability.
CSFDVod
object

CSFDPremiere

Premiere information for different countries and formats.
CSFDPremiere
object

CSFDTitlesOther

Alternative movie titles in different countries.
CSFDTitlesOther
object

CSFDMovieListItem

Simplified movie reference for lists (related, similar movies).
CSFDMovieListItem
object

CSFDParent

Parent series/season information for episodes.
CSFDParent
object

CSFDSeriesChild

Represents a season or episode in a series.
CSFDSeriesChild
object

Type Definitions

CSFDVodService

All supported video-on-demand services:
type CSFDVodService =
  | 'Netflix'
  | 'hbogo'
  | 'Prime Video'
  | 'Apple TV+'
  | 'iTunes'
  | 'KVIFF.TV'
  | 'Edisonline'
  | 'o2tv'
  | 'SledovaniTV'
  | 'Starmax'
  | 'DAFilms'
  | 'FILMY ČESKY A ZADARMO'
  | 'Youtube Česká filmová klasika'
  | 'VAPET'
  | 'VOREL FILM'
  | 'ivysilani'
  | 'Google Play'
  | 'Voyo'
  | 'YouTube Movies'
  | 'prima+'
  | 'Lepší.TV'
  | 'Blu-ray'
  | 'DVD';

CSFDGenres

All ČSFD movie genres:
type CSFDGenres =
  | 'Akční'
  | 'Animovaný'
  | 'Dobrodružný'
  | 'Dokumentární'
  | 'Drama'
  | 'Experimentální'
  | 'Fantasy'
  | 'Film-Noir'
  | 'Historický'
  | 'Horor'
  | 'Hudební'
  | 'IMAX'
  | 'Katastrofický'
  | 'Komedie'
  | 'Krátkometrážní'
  | 'Krimi'
  | 'Loutkový'
  | 'Muzikál'
  | 'Mysteriózní'
  | 'Naučný'
  | 'Podobenství'
  | 'Poetický'
  | 'Pohádka'
  | 'Povídkový'
  | 'Psychologický'
  | 'Publicistický'
  | 'Reality-TV'
  | 'Road movie'
  | 'Rodinný'
  | 'Romantický'
  | 'Sci-Fi'
  | 'Soutěžní'
  | 'Sportovní'
  | 'Stand-up'
  | 'Talk-show'
  | 'Taneční'
  | 'Telenovela'
  | 'Thriller'
  | 'Válečný'
  | 'Western'
  | 'Zábavný'
  | 'Životopisný';

CSFDCreatorGroups

Creator role labels in Czech:
type CSFDCreatorGroups =
  | 'Režie'
  | 'Scénář'
  | 'Kamera'
  | 'Hudba'
  | 'Hrají'
  | 'Produkce'
  | 'Casting'
  | 'Střih'
  | 'Zvuk'
  | 'Masky'
  | 'Předloha'
  | 'Scénografie'
  | 'Kostýmy';

CSFDCreatorGroupsEnglish

Creator role labels in English:
type CSFDCreatorGroupsEnglish =
  | 'Directed by'
  | 'Screenplay'
  | 'Cinematography'
  | 'Composer'
  | 'Cast'
  | 'Produced by'
  | 'Casting'
  | 'Editing'
  | 'Sound'
  | 'Make-up'
  | 'Production design'
  | 'Based on'
  | 'Costumes';

CSFDCreatorGroupsSlovak

Creator role labels in Slovak:
type CSFDCreatorGroupsSlovak =
  | 'Réžia'
  | 'Scenár'
  | 'Kamera'
  | 'Hudba'
  | 'Hrajú'
  | 'Predloha'
  | 'Produkcia'
  | 'Strih'
  | 'Kostýmy'
  | 'Scénografia';

CSFDBoxContent

Types of related content boxes:
type CSFDBoxContent = 'Související' | 'Podobné';

Import Example

import type {
  CSFDMovie,
  CSFDCreators,
  CSFDMovieCreator,
  CSFDVod,
  CSFDVodService,
  CSFDPremiere,
  CSFDGenres,
  CSFDTitlesOther,
  CSFDMovieListItem,
  CSFDParent,
  CSFDSeriesChild,
} from 'node-csfd-api';

TypeScript Interface

import { CSFDScreening } from './global';

export interface CSFDMovie extends CSFDScreening {
  rating: number | null;
  poster: string;
  photo: string;
  ratingCount: number | null;
  duration: number | string;
  titlesOther: CSFDTitlesOther[];
  origins: string[];
  descriptions: string[];
  trivia: string[];
  genres: CSFDGenres[] | string[];
  creators: CSFDCreators;
  vod: CSFDVod[];
  tags: string[];
  premieres: CSFDPremiere[];
  related: CSFDMovieListItem[];
  similar: CSFDMovieListItem[];
  seasons: CSFDSeriesChild[] | null;
  episodes: CSFDSeriesChild[] | null;
  parent: CSFDParent | null;
  episodeCode: string | null;
  seasonName: string | null;
}

export interface CSFDCreators {
  directors: CSFDMovieCreator[];
  writers: CSFDMovieCreator[];
  cinematography: CSFDMovieCreator[];
  music: CSFDMovieCreator[];
  actors: CSFDMovieCreator[];
  basedOn: CSFDMovieCreator[];
  producers: CSFDMovieCreator[];
  filmEditing: CSFDMovieCreator[];
  costumeDesign: CSFDMovieCreator[];
  productionDesign: CSFDMovieCreator[];
}

export interface CSFDMovieCreator {
  id: number;
  name: string;
  url: string;
}

export interface CSFDVod {
  title: CSFDVodService;
  url: string;
}

export interface CSFDPremiere {
  country: string;
  format: string;
  date: string;
  company: string;
}

Build docs developers (and LLMs) love