JSONAPIXtreamShow: {
    type: "show";
    id: string;
    attributes: {
        name: string;
        plot: string | null;
        voteAverage: number;
        poster: string;
        cover: string;
        releaseDate: Date | null;
        duration: number;
        cast: string[];
        director: string[];
        genre: string[];
        youtubeId: string | null;
        updatedAt: Date;
    };
    relationships?: {
        categories?: { data: { type: "show-category"; id: string }[] };
        seasons?: { data: { type: "season"; id: string }[] };
        episodes?: { data: { type: "episode"; id: string }[] };
    };
}

JSON:API Xtream show information

This type represents a show in the Xtream system in JSON:API format

Type declaration

  • type: "show"

    The resource type (show)

  • id: string

    The unique identifier for the show

  • attributes: {
        name: string;
        plot: string | null;
        voteAverage: number;
        poster: string;
        cover: string;
        releaseDate: Date | null;
        duration: number;
        cast: string[];
        director: string[];
        genre: string[];
        youtubeId: string | null;
        updatedAt: Date;
    }

    The show attributes

    • name: string

      The title of the show

    • plot: string | null

      The synopsis/description of the show

    • voteAverage: number

      The show's rating

    • poster: string

      The URL for the show's poster image

    • cover: string

      The URL for the show's cover image

    • releaseDate: Date | null

      The release date of the show

    • duration: number

      The average runtime of episodes in seconds

    • cast: string[]

      The cast members of the show as an array

    • director: string[]

      The director(s) of the show as an array

    • genre: string[]

      The genre(s) of the show as an array

    • youtubeId: string | null

      Youtube ID of trailer

    • updatedAt: Date

      The date when the show was last updated

  • Optionalrelationships?: {
        categories?: { data: { type: "show-category"; id: string }[] };
        seasons?: { data: { type: "season"; id: string }[] };
        episodes?: { data: { type: "episode"; id: string }[] };
    }

    The show relationships

    • Optionalcategories?: { data: { type: "show-category"; id: string }[] }

      The categories relationship if applicable

    • Optionalseasons?: { data: { type: "season"; id: string }[] }

      The seasons relationship if applicable

    • Optionalepisodes?: { data: { type: "episode"; id: string }[] }

      The episodes relationship if applicable