Class Game

Classe représentant un jeu vidéo. Utilise l'API v4.

Constructors

constructor

Accessors

id machineId

Methods

doesGameExist getDetails getImages getInfos getLightInfos getNews getReviews getReviewsStats getVideos getWikis

Constructors

constructor

  • new Game(id: number, options?: { machineId?: number }): Game

    Crée une nouvelle instance de la classe Game.

    Attention, si le paramètre optionnel machineId est spécifié, cet ID sera considéré comme la valeur par défaut du paramètre optionnel machineId de toutes les méthodes de la classe, au lieu de undefined.

    Parameters

    • id: number

      ID du jeu

    • Optionaloptions: { machineId?: number } = {}
      • OptionalmachineId?: number

        ID de la machine auquel se rapporte spécifiquement le jeu (optionnel)

    Returns Game

Accessors

id

machineId

  • get machineId(): undefined | number

    Renvoie l'ID de la machine associée au jeu.

    Returns undefined | number

Methods

doesGameExist

getDetails

  • getDetails(options?: { machineId?: number }): Promise<GameDetails>

    Renvoie les informations détaillées du jeu vidéo.

    Parameters

    • Optionaloptions: { machineId?: number } = {}
      • OptionalmachineId?: number

        à renseigner pour traiter une machine spécifique du jeu, par défaut les données globales du jeu sont renvoyées

    Returns Promise<GameDetails>

    Throws

    NonexistentContent si le jeu n'existe pas ou si la machine spécifiée n'existe pas sur le jeu

getImages

  • getImages(options?: { machineId?: number }): Promise<Images>

    Renvoie un objet contenant les URL des images associées au jeu.

    Parameters

    • Optionaloptions: { machineId?: number } = {}
      • OptionalmachineId?: number

        à renseigner pour traiter une machine spécifique du jeu, par défaut les données globales du jeu sont renvoyées

    Returns Promise<Images>

    Throws

    NonexistentContent si le jeu n'existe pas ou si la machine spécifiée n'existe pas sur le jeu

getInfos

  • getInfos(options?: { machineId?: number }): Promise<V4Types.Game.Infos>

    Renvoie les informations du jeu vidéo.

    Parameters

    • Optionaloptions: { machineId?: number } = {}
      • OptionalmachineId?: number

        à renseigner pour traiter une machine spécifique du jeu, par défaut les données globales du jeu sont renvoyées

    Returns Promise<V4Types.Game.Infos>

    Throws

    NonexistentContent si le jeu n'existe pas ou si la machine spécifiée n'existe pas sur le jeu

getLightInfos

  • getLightInfos(options?: { machineId?: number }): Promise<V4Types.Game.Generic>

    Renvoie les informations génériques du jeu vidéo.

    Parameters

    • Optionaloptions: { machineId?: number } = {}
      • OptionalmachineId?: number

        à renseigner pour traiter une machine spécifique du jeu, par défaut les données globales du jeu sont renvoyées

    Returns Promise<V4Types.Game.Generic>

    Throws

    NonexistentContent si le jeu n'existe pas ou si la machine spécifiée n'existe pas sur le jeu

getNews

  • getNews(
        options?: {
            machineId?: number;
            paging?: Pagination;
            perPage?: number;
            raw?: boolean;
        },
    ): AsyncGenerator<V4Types.Contents.Raw | Content[], void, unknown>

    Renvoie un générateur asynchrone des actualités associées au jeu situées aux pages décrites par le paramètre paging.

    Parameters

    • Optionaloptions: { machineId?: number; paging?: Pagination; perPage?: number; raw?: boolean }
      • OptionalmachineId?: number

        à renseigner pour traiter une machine spécifique du jeu, par défaut les données globales du jeu sont renvoyées

      • Optionalpaging?: Pagination

        objet décrivant les pages à traiter (par défaut vide : toutes les pages le sont)

      • OptionalperPage?: number

        nombre d'entités par page, par défaut 20

      • Optionalraw?: boolean

        true pour renvoyer un objet JSON brut (V4Types.Contents.Raw), par défaut false pour utiliser les classes fournies par la librairie (Content)

    Returns AsyncGenerator<V4Types.Contents.Raw | Content[], void, unknown>

    Example

    const game = new Game(531990);
    for await (const page of game.getNews()) {
         console.log(page);
    }

    Throws

    NonexistentContent si le jeu n'existe pas ou si la machine spécifiée n'existe pas sur le jeu

  • getNews(
        options: {
            machineId?: number;
            page: number;
            perPage?: number;
            raw?: boolean;
        },
    ): Promise<V4Types.Contents.Raw | Content[]>

    Renvoie les actualités associées au jeu situées à une page particulière.

    Parameters

    • options: { machineId?: number; page: number; perPage?: number; raw?: boolean }
      • OptionalmachineId?: number

        à renseigner pour traiter une machine spécifique du jeu, par défaut les données globales du jeu sont renvoyées

      • page: number

        numéro de la page à traiter

      • OptionalperPage?: number

        nombre d'entités par page, par défaut 20

      • Optionalraw?: boolean

        true pour renvoyer un objet JSON brut (V4Types.Contents.Raw), par défaut false pour utiliser les classes fournies par la librairie (Content)

    Returns Promise<V4Types.Contents.Raw | Content[]>

    Example

    const game = new Game(531990);
    console.log(await game.getNews({ page: 2 }));

    Throws

    NonexistentContent si le jeu n'existe pas ou si la machine spécifiée n'existe pas sur le jeu

getReviews

  • getReviews(
        machineId: number,
        options?: { paging?: Pagination; perPage?: number; raw?: boolean },
    ): AsyncGenerator<V4Types.Game.Reviews.Raw | Review[], void, unknown>

    Renvoie un générateur asynchrone des avis sur le jeu, sur la machine spécifiée et situés aux pages décrites par le paramètre paging.

    Parameters

    • machineId: number

      l'ID de la machine

    • Optionaloptions: { paging?: Pagination; perPage?: number; raw?: boolean }
      • Optionalpaging?: Pagination

        objet décrivant les pages à traiter (par défaut vide : toutes les pages le sont)

      • OptionalperPage?: number

        nombre d'entités par page, par défaut 20

      • Optionalraw?: boolean

        true pour renvoyer un objet JSON brut (V4Types.Game.Reviews.Raw), par défaut false pour utiliser les classes fournies par la librairie (Review)

    Returns AsyncGenerator<V4Types.Game.Reviews.Raw | Review[], void, unknown>

    Example

    const game = new Game(531990);
    for await (const page of game.getReviews(10)) {
         console.log(page);
    }

    Throws

    NonexistentContent si le jeu n'existe pas ou si la machine spécifiée n'existe pas sur le jeu

  • getReviews(
        machineId: number,
        options: { page: number; perPage?: number; raw?: boolean },
    ): Promise<V4Types.Game.Reviews.Raw | Review[]>

    Renvoie les avis sur le jeu, sur la machine spécifiée et situés à une page particulière.

    Parameters

    • machineId: number

      l'ID de la machine

    • options: { page: number; perPage?: number; raw?: boolean }
      • page: number

        numéro de la page à traiter

      • OptionalperPage?: number

        nombre d'entités par page, par défaut 20

      • Optionalraw?: boolean

        true pour renvoyer un objet JSON brut (V4Types.Game.Reviews.Raw), par défaut false pour utiliser les classes fournies par la librairie (Review)

    Returns Promise<V4Types.Game.Reviews.Raw | Review[]>

    Example

    const game = new Game(531990);
    console.log(await game.getReviews(10, { page: 2 }));

    Throws

    NonexistentContent si le jeu n'existe pas ou si la machine spécifiée n'existe pas sur le jeu

getReviewsStats

getVideos

  • getVideos(
        options?: {
            machineId?: number;
            paging?: Pagination;
            perPage?: number;
            raw?: boolean;
        },
    ): AsyncGenerator<V4Types.Videos.Raw | Video[], void, unknown>

    Renvoie un générateur asynchrone des vidéos associées au jeu situées aux pages décrites par le paramètre paging.

    Parameters

    • Optionaloptions: { machineId?: number; paging?: Pagination; perPage?: number; raw?: boolean }
      • OptionalmachineId?: number

        à renseigner pour traiter une machine spécifique du jeu, par défaut les données globales du jeu sont renvoyées

      • Optionalpaging?: Pagination

        objet décrivant les pages à traiter (par défaut vide : toutes les pages le sont)

      • OptionalperPage?: number

        nombre d'entités par page, par défaut 20

      • Optionalraw?: boolean

        true pour renvoyer un objet JSON brut (V4Types.Videos.Raw), par défaut false pour utiliser les classes fournies par la librairie (Video)

    Returns AsyncGenerator<V4Types.Videos.Raw | Video[], void, unknown>

    Example

    const game = new Game(531990);
    for await (const page of game.getVideos()) {
         console.log(page);
    }

    Throws

    NonexistentContent si le jeu n'existe pas ou si la machine spécifiée n'existe pas sur le jeu

  • getVideos(
        options: {
            machineId?: number;
            page: number;
            perPage?: number;
            raw?: boolean;
        },
    ): Promise<V4Types.Videos.Raw | Video[]>

    Renvoie les vidéos associées au jeu situées à une page particulière.

    Parameters

    • options: { machineId?: number; page: number; perPage?: number; raw?: boolean }
      • OptionalmachineId?: number

        à renseigner pour traiter une machine spécifique du jeu, par défaut les données globales du jeu sont renvoyées

      • page: number

        numéro de la page à traiter

      • OptionalperPage?: number

        nombre d'entités par page, par défaut 20

      • Optionalraw?: boolean

        true pour renvoyer un objet JSON brut (V4Types.Videos.Raw), par défaut false pour utiliser les classes fournies par la librairie (Video)

    Returns Promise<V4Types.Videos.Raw | Video[]>

    Example

    const game = new Game(531990);
    console.log(await game.getVideos({ page: 2 }));

    Throws

    NonexistentContent si le jeu n'existe pas ou si la machine spécifiée n'existe pas sur le jeu

getWikis

  • getWikis(
        options?: {
            machineId?: number;
            paging?: Pagination;
            perPage?: number;
            raw?: boolean;
        },
    ): AsyncGenerator<V4Types.Contents.Raw | Content[], void, unknown>

    Renvoie un générateur asynchrone des wikis associés au jeu situés aux pages décrites par le paramètre paging.

    Parameters

    • Optionaloptions: { machineId?: number; paging?: Pagination; perPage?: number; raw?: boolean }
      • OptionalmachineId?: number

        à renseigner pour traiter une machine spécifique du jeu, par défaut les données globales du jeu sont renvoyées

      • Optionalpaging?: Pagination

        objet décrivant les pages à traiter (par défaut vide : toutes les pages le sont)

      • OptionalperPage?: number

        nombre d'entités par page, par défaut 20

      • Optionalraw?: boolean

        true pour renvoyer un objet JSON brut (V4Types.Contents.Raw), par défaut false pour utiliser les classes fournies par la librairie (Content)

    Returns AsyncGenerator<V4Types.Contents.Raw | Content[], void, unknown>

    Example

    const game = new Game(531990);
    for await (const page of game.getWikis()) {
         console.log(page);
    }

    Throws

    NonexistentContent si le jeu n'existe pas ou si la machine spécifiée n'existe pas sur le jeu

  • getWikis(
        options: {
            machineId?: number;
            page: number;
            perPage?: number;
            raw?: boolean;
        },
    ): Promise<V4Types.Contents.Raw | Content[]>

    Renvoie les wikis associés au jeu situés à une page particulière.

    Parameters

    • options: { machineId?: number; page: number; perPage?: number; raw?: boolean }
      • OptionalmachineId?: number

        à renseigner pour traiter une machine spécifique du jeu, par défaut les données globales du jeu sont renvoyées

      • page: number

        numéro de la page à traiter

      • OptionalperPage?: number

        nombre d'entités par page, par défaut 20

      • Optionalraw?: boolean

        true pour renvoyer un objet JSON brut (V4Types.Contents.Raw), par défaut false pour utiliser les classes fournies par la librairie (Content)

    Returns Promise<V4Types.Contents.Raw | Content[]>

    Example

    const game = new Game(531990);
    console.log(await game.getWikis({ page: 2 }));

    Throws

    NonexistentContent si le jeu n'existe pas ou si la machine spécifiée n'existe pas sur le jeu

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods