Skip to main content

Class: HonkaiImpact

Class representing the Honkai Impact 3rd game.

Constructors​

constructor​

• new HonkaiImpact(options)

Create a new instance of HonkaiImpact.

Parameters​

NameTypeDescription
optionsIHi3OptionsThe options object used to configure the object.

Defined in​

src/client/hi/hi.ts:75

Properties​

• Readonly cookie: ICookie

The cookie used for authentication.

Defined in​

src/client/hi/hi.ts:44


daily​

• Readonly daily: DailyModule

The Daily module for the Honkai Impact 3rd game.

Defined in​

src/client/hi/hi.ts:24


lang​

• Private lang: LanguageEnum

The language of the Honkai Impact 3rd account.

Defined in​

src/client/hi/hi.ts:68


record​

• Readonly record: HIRecordModule

The HIRecordModule object provides an interface to interact with the user record feature in Honkai Star Rails.

Defined in​

src/client/hi/hi.ts:38


redeem​

• Readonly redeem: RedeemModule

The Redeem module for the Honkai Impact 3rd game.

Defined in​

src/client/hi/hi.ts:32


region​

• Readonly region: null | string

The region of the Honkai Impact 3rd account.

Defined in​

src/client/hi/hi.ts:62


request​

• Private request: HTTPRequest

The request object used to make HTTP requests.

Defined in​

src/client/hi/hi.ts:50


uid​

• Readonly uid: null | number

The UID of the Honkai Impact 3rd account.

Defined in​

src/client/hi/hi.ts:56

Methods​

dailyClaim​

▸ dailyClaim(): Promise<IDailyClaim>

Claim current reward

Alias

DailyModule.claim

Deprecated

Use through HonkaiImpact.daily.claim() instead

Returns​

Promise<IDailyClaim>

Defined in​

src/client/hi/hi.ts:158


dailyInfo​

▸ dailyInfo(): Promise<IDailyInfo>

Retrieves daily information.

Alias

DailyModule.info

Deprecated

Use through HonkaiImpact.daily.info() instead

Returns​

Promise<IDailyInfo>

Defined in​

src/client/hi/hi.ts:125


dailyReward​

▸ dailyReward(day?): Promise<IDailyReward>

Fetch reward from daily login based on day

Alias

DailyModule.reward

Deprecated

Use through HonkaiImpact.daily.reward() instead

Parameters​

NameTypeDefault valueDescription
daynull | numbernullnumber | null

Returns​

Promise<IDailyReward>

Defined in​

src/client/hi/hi.ts:147


dailyRewards​

▸ dailyRewards(): Promise<IDailyRewards>

Alias

DailyModule.rewards

Deprecated

Use through HonkaiImpact.daily.rewards() instead

Returns​

Promise<IDailyRewards>

Defined in​

src/client/hi/hi.ts:135


redeemCode​

▸ redeemCode(code): Promise<IRedeemCode>

Redeem Code

Alias

RedeemModule.claim

Deprecated

Use through HonkaiImpact.redeem.claim() instead

Parameters​

NameTypeDescription
codestringstring

Returns​

Promise<IRedeemCode>

Defined in​

src/client/hi/hi.ts:170