Class Challenges

constructor

• new Challenges(api: API, account: Account): Challenges

  Creates a Challenges instance

  Parameters

  • api: API

    The API instance to use for requests

  • account: Account

    The Account instance to use for data and authentication

  Returns Challenges

claim

• claim(
      challengeId: number,
  ): Promise<
      | { eggReward: number; ok: true; updatedChallenges: AccountChallenge[] }
      | { error: APIError | ChallengeClaimError; ok: false },
  >

  Claims the reward for a completed challenge with the game's server

  Parameters

  • challengeId: number

    The ID of the challenge to claim

  Returns Promise<
      | { eggReward: number; ok: true; updatedChallenges: AccountChallenge[] }
      | { error: APIError | ChallengeClaimError; ok: false },
  >

  The claim result

import

• import(challengeData: RawChallengeData[]): void

  Imports raw challenge data into the challenge list

  Parameters

  • challengeData: RawChallengeData[]

    Raw challenge data from the API

  Returns void

refresh

• refresh(): Promise<
      | { challenges: AccountChallenge[]; ok: true }
      | { error: ChallengeRefreshError | APIError; ok: false },
  >

  Refreshes challenges with the game's server

  Returns Promise<
      | { challenges: AccountChallenge[]; ok: true }
      | { error: ChallengeRefreshError | APIError; ok: false },
  >

  The refresh result

reroll

• reroll(
      challengeId: number,
  ): Promise<
      | { newChallenges: AccountChallenge[]; ok: true }
      | { error: APIError | ChallengeRerollError; ok: false },
  >

  Rerolls a challenge slot with the game's server

  Parameters

  • challengeId: number

    The ID of the challenge to reroll

  Returns Promise<
      | { newChallenges: AccountChallenge[]; ok: true }
      | { error: APIError | ChallengeRerollError; ok: false },
  >

  The reroll result

account

api

list