Class V4Abstract

Classe contenant des méthodes statiques permettant de récupérer des jeux vidéo et des contenus selon des critères précis grâce à l'API v4.

Methods

getContents getGames getGamesReleases getGamesSummary getHighTechContents getTrendingContents searchArticles searchGames searchNews searchVideos searchWikis

Methods

StaticgetContents

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

    Renvoie un générateur asynchrone des contenus (actualités, articles, wikis...) situés aux pages décrites par le paramètre paging et satisfaisant au query donné.

    Parameters

    • Optionaloptions: { paging?: Pagination; perPage?: number; query?: ContentsQuery; 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

      • Optionalquery?: ContentsQuery

        à renseigner pour affiner la recherche

      • Optionalraw?: boolean

        true pour renvoyer des objets 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

    for await (const page of V4.getContents()) {
         console.log(page);
    }
  • getContents(
        options: {
            page: number;
            perPage?: number;
            query?: ContentsQuery;
            raw?: boolean;
        },
    ): Promise<V4Types.Contents.Raw | Content[]>

    Renvoie les contenus (actualités, articles, wikis...) situés à une page particulière et satisfaisant au query donné.

    Parameters

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

        numéro de la page à traiter

      • OptionalperPage?: number

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

      • Optionalquery?: ContentsQuery

        à renseigner pour affiner la recherche

      • Optionalraw?: boolean

        true pour renvoyer des objets 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

    console.log(await V4.getContents({ page: 2 }));

StaticgetGames

  • getGames(
        options?: {
            paging?: Pagination;
            perPage?: number;
            query?: GamesQuery;
            raw?: boolean;
        },
    ): AsyncGenerator<Game[] | V4Types.Games.Raw, void, unknown>

    Renvoie un générateur asynchrone des jeux vidéo situés aux pages décrites par le paramètre paging et satisfaisant au query donné.

    Parameters

    • Optionaloptions: { paging?: Pagination; perPage?: number; query?: GamesQuery; 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

      • Optionalquery?: GamesQuery

        à renseigner pour affiner la recherche

      • Optionalraw?: boolean

        true pour renvoyer des objets JSON brut (V4Types.Games.Raw), par défaut false pour utiliser les classes fournies par la librairie (Game)

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

    Example

    for await (const page of V4.getGames()) {
         console.log(page);
    }
  • getGames(
        options: {
            page: number;
            perPage?: number;
            query?: GamesQuery;
            raw?: boolean;
        },
    ): AsyncGenerator<Game[] | V4Types.Games.Raw, void, unknown>

    Renvoie les jeux vidéo situés à une page particulière et satisfaisant au query donné.

    Parameters

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

        numéro de la page à traiter

      • OptionalperPage?: number

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

      • Optionalquery?: GamesQuery

        à renseigner pour affiner la recherche

      • Optionalraw?: boolean

        true pour renvoyer des objets JSON brut (V4Types.Games.Raw), par défaut false pour utiliser les classes fournies par la librairie (Game)

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

    Example

    console.log(await V4.getGames({ page: 2 }));

StaticgetGamesReleases

  • getGamesReleases(
        options?: {
            paging?: Pagination;
            perPage?: number;
            query?: ReleasesQuery;
            raw?: boolean;
        },
    ): AsyncGenerator<Game[] | V4Types.Games.Raw, void, unknown>

    Renvoie un générateur asynchrone des sorties de jeux vidéo situées aux pages décrites par le paramètre paging et satisfaisant au query donné.

    Parameters

    • Optionaloptions: { paging?: Pagination; perPage?: number; query?: ReleasesQuery; 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

      • Optionalquery?: ReleasesQuery

        à renseigner pour affiner la recherche

      • Optionalraw?: boolean

        true pour renvoyer des objets JSON brut (V4Types.Games.Raw), par défaut false pour utiliser les classes fournies par la librairie (Game)

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

    Example

    for await (const page of V4.getGamesReleases()) {
         console.log(page);
    }
  • getGamesReleases(
        options?: {
            page: number;
            perPage?: number;
            query?: ReleasesQuery;
            raw?: boolean;
        },
    ): AsyncGenerator<Game[] | V4Types.Games.Raw, void, unknown>

    Renvoie les sorties de jeux vidéo situés à une page particulière et satisfaisant au query donné.

    Parameters

    • Optionaloptions: { page: number; perPage?: number; query?: ReleasesQuery; raw?: boolean }
      • page: number

        numéro de la page à traiter

      • OptionalperPage?: number

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

      • Optionalquery?: ReleasesQuery

        à renseigner pour affiner la recherche

      • Optionalraw?: boolean

        true pour renvoyer des objets JSON brut (V4Types.Games.Raw), par défaut false pour utiliser les classes fournies par la librairie (Game)

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

    Example

    console.log(await V4.getGamesReleases({ page: 2 }));

StaticgetGamesSummary

StaticgetHighTechContents

  • getHighTechContents(
        options?: { paging?: Pagination; perPage?: number; raw?: boolean },
    ): AsyncGenerator<RawHighTech | HighTech, void, unknown>

    Renvoie un générateur asynchrone des contenus high-tech situés aux pages décrites par le paramètre paging.

    Parameters

    • 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 des objets JSON brut (V4Types.Contents.RawHighTech), par défaut false pour utiliser les classes fournies par la librairie (V4Types.Contents.HighTech)

    Returns AsyncGenerator<RawHighTech | HighTech, void, unknown>

    Example

    for await (const page of V4.getHighTechContents()) {
         console.log(page);
    }
  • getHighTechContents(
        options: { page: number; perPage?: number; raw?: boolean },
    ): Promise<RawHighTech | HighTech>

    Renvoie les contenus high-tech situés à une page particulière.

    Parameters

    • 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 des objets JSON brut (V4Types.Contents.RawHighTech), par défaut false pour utiliser les classes fournies par la librairie (V4Types.Contents.HighTech)

    Returns Promise<RawHighTech | HighTech>

    Example

    console.log(await V4.getHighTechContents({ page: 2 }));

StaticgetTrendingContents

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

    Renvoie un générateur asynchrone des contenus tendance situés aux pages décrites par le paramètre paging.

    Parameters

    • 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 des objets 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

    for await (const page of V4.getTrendingContents()) {
         console.log(page);
    }
  • getTrendingContents(
        options: { page: number; perPage?: number; raw?: boolean },
    ): Promise<V4Types.Contents.Raw | Content[]>

    Renvoie les contenus tendance situés à une page particulière.

    Parameters

    • 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 des objets 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

    console.log(await V4.getTrendingContents({ page: 2 }));

StaticsearchArticles

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

    Renvoie un générateur asynchrone des articles correspondant aux termes de recherche et situés aux pages décrites par le paramètre paging.

    Parameters

    • q: string

      termes de recherche

    • 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 des objets 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

    for await (const page of V4.searchArticles("test")) {
         console.log(page);
    }
  • searchArticles(
        q: string,
        options: { page: number; perPage?: number; raw?: boolean },
    ): Promise<V4Types.Contents.Raw | Content[]>

    Renvoie les articles correspondant aux termes de recherche et situés à une page particulière.

    Parameters

    • q: string

      termes de recherche

    • 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 des objets 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

    console.log(await V4.searchArticles("test", { page: 2 }));

StaticsearchGames

  • searchGames(
        q: string,
        options?: { paging?: Pagination; perPage?: number; raw?: boolean },
    ): AsyncGenerator<Game[] | V4Types.Games.Raw, void, unknown>

    Renvoie un générateur asynchrone des jeux correspondant aux termes de recherche et situés aux pages décrites par le paramètre paging.

    Parameters

    • q: string

      termes de recherche

    • 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 des objets JSON brut (V4Types.Games.Raw), par défaut false pour utiliser les classes fournies par la librairie (Game)

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

    Example

    for await (const page of V4.searchGames("test")) {
         console.log(page);
    }
  • searchGames(
        q: string,
        options: { page: number; perPage?: number; raw?: boolean },
    ): Promise<Game[] | V4Types.Games.Raw>

    Renvoie les jeux correspondant aux termes de recherche et situés à une page particulière.

    Parameters

    • q: string

      termes de recherche

    • 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 des objets JSON brut (V4Types.Games.Raw), par défaut false pour utiliser les classes fournies par la librairie (Game)

    Returns Promise<Game[] | V4Types.Games.Raw>

    Example

    console.log(await V4.searchGames("test", { page: 2 }));

StaticsearchNews

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

    Renvoie un générateur asynchrone des news correspondant aux termes de recherche et situées aux pages décrites par le paramètre paging.

    Parameters

    • q: string

      termes de recherche

    • 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 des objets 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

    for await (const page of V4.searchNews("test")) {
         console.log(page);
    }
  • searchNews(
        q: string,
        options: { page: number; perPage?: number; raw?: boolean },
    ): Promise<V4Types.Contents.Raw | Content[]>

    Renvoie les news correspondant aux termes de recherche et situées à une page particulière.

    Parameters

    • q: string

      termes de recherche

    • 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 des objets 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

    console.log(await V4.searchNews("test", { page: 2 }));

StaticsearchVideos

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

    Renvoie un générateur asynchrone des vidéos correspondant aux termes de recherche et situées aux pages décrites par le paramètre paging.

    Parameters

    • q: string

      termes de recherche

    • 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 des objets 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

    for await (const page of V4.searchVideos("test")) {
         console.log(page);
    }
  • searchVideos(
        q: string,
        options: { page: number; perPage?: number; raw?: boolean },
    ): Promise<V4Types.Videos.Raw | Video[]>

    Renvoie les vidéos correspondant aux termes de recherche et situées à une page particulière.

    Parameters

    • q: string

      termes de recherche

    • 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 des objets 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

    console.log(await V4.searchVideos("test", { page: 2 }));

StaticsearchWikis

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

    Renvoie un générateur asynchrone des wikis correspondant aux termes de recherche et situés aux pages décrites par le paramètre paging.

    Parameters

    • q: string

      termes de recherche

    • 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 des objets 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

    for await (const page of V4.searchWikis("test")) {
         console.log(page);
    }
  • searchWikis(
        q: string,
        options: { page: number; perPage?: number; raw?: boolean },
    ): Promise<V4Types.Contents.Raw | Content[]>

    Renvoie les wikis correspondant aux termes de recherche et situés à une page particulière.

    Parameters

    • q: string

      termes de recherche

    • 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 des objets 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

    console.log(await V4.searchWikis("test", { page: 2 }));

Settings

Member Visibility

On This Page

Methods