Class ChiknWinner

constructor

• new ChiknWinner(account: Account): ChiknWinner

  Creates a new ChiknWinner instance. Automatically initialized with an Account

  Parameters

  • account: Account

    The account it pulls with

  Returns ChiknWinner

check

• check(): Promise<
      | { cw: ChiknWinner; ok: true }
      | ErrorEnum<FirebaseError | QueryServicesError | ChicknWinnerError>,
  >

  Checks the account's chikn winner status (if it can pull, if not, cooldown until it can)

  Returns Promise<
      | { cw: ChiknWinner; ok: true }
      | ErrorEnum<FirebaseError | QueryServicesError | ChicknWinnerError>,
  >

  An object containing the updated ChiknWinner instance, or an error if the request failed

play

• play(
      doPrematureCooldownCheck?: boolean,
  ): Promise<
      | ErrorEnum<FirebaseError | QueryServicesError | ChicknWinnerError>
      | { eggsGiven: number; itemIds: number[]; ok: true; rewardTier: number },
  >

  Attempts to pull from chikn winner

  Parameters

  • doPrematureCooldownCheck: boolean = true

    Whether to run the premature cooldown check based on the last check's cooldown time. Set this to false to ignore the cooldown time from the last check, and just attempt to play (unstable)

  Returns Promise<
      | ErrorEnum<FirebaseError | QueryServicesError | ChicknWinnerError>
      | { eggsGiven: number; itemIds: number[]; ok: true; rewardTier: number },
  >

  An object containing the reward if successful, or an error if there was a failure

reset

• reset(): Promise<
      | ErrorEnum<FirebaseError | QueryServicesError | ChicknWinnerError>
      | { cw: ChiknWinner; ok: true },
  >

  Resets the account's chikn winner cooldown for 200 eggs

  Returns Promise<
      | ErrorEnum<FirebaseError | QueryServicesError | ChicknWinnerError>
      | { cw: ChiknWinner; ok: true },
  >

  An object containing the updated ChiknWinner instance if successful, or an error if the request failed

account

atLimit

canPlayAgain

pulls