Class HonkaiImpact

constructor

• new HonkaiImpact(options): HonkaiImpact

• Create a new instance of HonkaiImpact.

  Parameters

  • options: IHi3Options

    The options object used to configure the object.

  Returns HonkaiImpact

Readonlycookie

Readonlydaily

Readonlyrecord

Readonlyredeem

Readonlyregion

Readonlyuid

account

• get account(): null | IGame

• Getter for the account property.

  Returns null | IGame

  The current value of the account property.
• set account(game): void

• Setter for the account property. Prevents from changing the value once set

  Parameters

  • game: null | IGame

    The game object to set as the account.

  Returns void

dailyClaim

• dailyClaim(): Promise<IDailyClaim>

• Claim current reward

  Returns Promise<IDailyClaim>

  Alias

  DailyModule.claim

  Deprecated

  Use through HonkaiImpact.daily.claim() instead

dailyInfo

• dailyInfo(): Promise<IDailyInfo>

• Retrieves daily information.

  Returns Promise<IDailyInfo>

  Alias

  DailyModule.info

  Deprecated

  Use through HonkaiImpact.daily.info() instead

dailyReward

• dailyReward(day?): Promise<IDailyReward>

• Fetch reward from daily login based on day

  Parameters

  • day: null | number = null

    number | null

  Returns Promise<IDailyReward>

  Alias

  DailyModule.reward

  Deprecated

  Use through HonkaiImpact.daily.reward() instead

dailyRewards

• dailyRewards(): Promise<IDailyRewards>

• Returns Promise<IDailyRewards>

  Alias

  DailyModule.rewards

  Deprecated

  Use through HonkaiImpact.daily.rewards() instead

redeemCode

• redeemCode(code): Promise<IRedeemCode>

• Redeem Code

  Parameters

  • code: string

    string

  Returns Promise<IRedeemCode>

  Alias

  RedeemModule.claim

  Deprecated

  Use through HonkaiImpact.redeem.claim() instead

Staticcreate

• create(options): Promise<HonkaiImpact>

• Create a new instance of HonkaiImpact using a Hoyolab account. If uid is not provided in the options, the account with the highest level will be used.

  Parameters

  • options: IHi3Options

    The options object used to configure the object.

  Returns Promise<HonkaiImpact>

  • A promise that resolves with a new HonkaiImpact instance.

  Throws

  Error Wnen the CookieTokenV2 is not set.

  Remarks

  If an object is instantiated from this method but options.cookie.cookieTokenV2 is not set, it will throw an error. This method will access an Endpoint that contains a list of game accounts, which requires the cookieTokenV2 option.