Class: HonkaiStarRail
Class representing the Honkai Star Rail game.
Constructors
constructor
• new HonkaiStarRail(options)
Create a new instance of HonkaiStarRail.
Parameters
| Name | Type | Description |
|---|---|---|
options | IHsrOptions | The options for the HonkaiStarRail instance. |
Defined in
Properties
cookie
• Readonly cookie: ICookie
The cookie used for authentication.
Defined in
daily
• Readonly daily: DailyModule
The Daily module for the Honkai Star Rail game.
Defined in
lang
• Private lang: LanguageEnum
The language of the Honkai Star Rail account.
Defined in
record
• Readonly record: HSRRecordModule
The HSRRecordModule object provides an interface to interact with the user record feature in Honkai Star Rails.
Defined in
redeem
• Readonly redeem: RedeemModule
The Redeem module for the Honkai Star Rail game.
Defined in
region
• Readonly region: null | string
The region of the Honkai Star Rail account.
Defined in
request
• Private request: HTTPRequest
The request object used to make HTTP requests.
Defined in
uid
• Readonly uid: null | number
The UID of the Honkai Star Rail account.
Defined in
Methods
dailyClaim
▸ dailyClaim(): Promise<IDailyClaim>
Claim current reward
Alias
Deprecated
Use through HonkaiStarRail.daily.claim() instead
Returns
Promise<IDailyClaim>
Defined in
dailyInfo
▸ dailyInfo(): Promise<IDailyInfo>
Retrieves daily information.
Alias
Deprecated
Use through HonkaiStarRail.daily.info() instead
Returns
Promise<IDailyInfo>
Defined in
dailyReward
▸ dailyReward(day?): Promise<IDailyReward>
Fetch reward from daily login based on day
Alias
Deprecated
Use through HonkaiStarRail.daily.reward() instead
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
day | null | number | null | number | null |
Returns
Promise<IDailyReward>
Defined in
dailyRewards
▸ dailyRewards(): Promise<IDailyRewards>
Alias
Deprecated
Use through HonkaiStarRail.daily.rewards() instead
Returns
Promise<IDailyRewards>
Defined in
redeemCode
▸ redeemCode(code): Promise<IRedeemCode>
Redeem Code
Alias
Deprecated
Use through HonkaiStarRail.redeem.claim() instead
Parameters
| Name | Type | Description |
|---|---|---|
code | string | string |
Returns
Promise<IRedeemCode>