Options
All
  • Public
  • Public/Protected
  • All
Menu

codingame-api-node-ts

Index

Variables

Const urls

urls: { achievement: string; career: string; challenge: string; coc: string; codingamer: string; comment: string; company: string; contribution: string; course: string; help: string; leaderboards: string; notification: string; puzzle: string; quest: string; school: string; testsession: string; vote: string; xp: string } = ...
internal

Type declaration

  • achievement: string
  • career: string
  • challenge: string
  • coc: string
  • codingamer: string
  • comment: string
  • company: string
  • contribution: string
  • course: string
  • help: string
  • leaderboards: string
  • notification: string
  • puzzle: string
  • quest: string
  • school: string
  • testsession: string
  • vote: string
  • xp: string

Functions

Const findAllMinimalProgress

Const findProgressByIds

  • findProgressByIds(ids: number[], userId: number): Promise<IPuzzleProgress[]>
  • Find puzzle informations and player's completion from an array of number IDs.

    Parameters

    • ids: number[]

      Every Puzzle IDs you want to inspect

    • userId: number

      User ID you want to retrieve the completion

    Returns Promise<IPuzzleProgress[]>

Const findProgressByPrettyId

  • findProgressByPrettyId(cookies: string, puzzlePrettyId: string, userId: number): Promise<IPuzzlePrettyProgress>
  • Find puzzle informations and player's completion from a "pretty ID" which is a string, found in the URL of the puzzle.

    Requires to log in before.

    Parameters

    • cookies: string

      The cookies string that you obtain when you're loggin in with loginSite

    • puzzlePrettyId: string

      Puzzle's "pretty ID", found in its URL.

    • userId: number

      User ID you want to retrieve the completion

    Returns Promise<IPuzzlePrettyProgress>

Const getClashLeaderboard

  • getClashLeaderboard(page: number, filter: { active: boolean; column: string; filter: string; keyword: string }, codinGamerPublicHandle: string): Promise<IClashLeaderboard>
  • Get the Clash Of Code Leaderboard

    Parameters

    • page: number

      Leaderboard's page

    • filter: { active: boolean; column: string; filter: string; keyword: string }

      Leaderboar's filter

      • active: boolean
      • column: string
      • filter: string
      • keyword: string
    • codinGamerPublicHandle: string

      Public Handle from the CodinGamer

    Returns Promise<IClashLeaderboard>

Const getCookies

  • getCookies(response: any): string
  • internal

    Parameters

    • response: any

    Returns string

Const getGlobalLeaderboard

  • getGlobalLeaderboard(page: number, category: string, filter: { active: boolean; column: string; filter: string; keyword: string }, codinGamerPublicHandle: string): Promise<IGlobalLeaderboard>
  • Get the global leaderboard

    Parameters

    • page: number

      Leaderboard's Page

    • category: string

      Leaderboard's category. Can be GENERAL, CONTESTS, BOT_PROGRAMMING, OPTIM or CODEGOLF

    • filter: { active: boolean; column: string; filter: string; keyword: string }

      Leaderboard's filter

      • active: boolean
      • column: string
      • filter: string
      • keyword: string
    • codinGamerPublicHandle: string

      Public Handle from the CodinGamer

    Returns Promise<IGlobalLeaderboard>

Const loginCodinGamer

  • Login to CodinGame as a CodinGamer

    Parameters

    • email: string

      Account Email

    • password: string

      Account Password

    Returns Promise<ILoginCodinGamer>

Generated using TypeDoc