igdb-types/dist/types/ReleaseDate.d.ts

TypeScript type definitions for IGDB API responses

import { DateCategoryEnum } from "../enums";
import { DateFormat } from "./DateFormat";
import { Platform } from "./Platform";
import { RegionEnum } from "../enums";
import { ReleaseDateRegion } from "./ReleaseDateRegion";
import { ReleaseDateStatus } from "./ReleaseDateStatus";
import { UUID, UnixTimestamp, ISODateString, Month, Year } from "./utility";
/**
 * Represents release date information.
 *
 * Request Path: https://api.igdb.com/v4/release_dates
 * Description: A handy endpoint that extends game release dates. Used to dig deeper into release dates, platforms and versions.
 */
export type ReleaseDate = {
    /** @deprecated DEPRECATED! Use `date_format` instead. */
    category?: number | DateCategoryEnum;
    /** UUID hash of the object. */
    checksum: UUID;
    /** Date this was initially added to the IGDB database. */
    created_at: UnixTimestamp | Date;
    /** The date of the release. */
    date?: ISODateString;
    /** Reference ID for Date Format. The format of the change date. */
    date_format?: number | DateFormat;
    /** Reference ID for Game. */
    game: number;
    /** A human readable representation of the date. */
    human?: string;
    /** The month as an integer starting at 1 (January). */
    m?: Month;
    /** Reference ID for Platform. The platform of the release. */
    platform: number | Platform;
    /** @deprecated DEPRECATED! Use `release_region` instead. */
    region?: number | RegionEnum;
    /** Reference ID for Release Date Region. The region of the release. */
    release_region: number | ReleaseDateRegion;
    /** Reference ID for Release Date Status. The status of the release. */
    status?: number | ReleaseDateStatus;
    /** The last date this entry was updated in the IGDB database. */
    updated_at: UnixTimestamp | Date;
    /** The year in full (2018). */
    y?: Year;
};