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
_account
• Private _account: null | IGame = null
HoyYolab account object
Defined in
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
Accessors
account
• get account(): null | IGame
Getter for the account property.
Returns
null | IGame
The current value of the account property.
Defined in
• set account(game): void
Setter for the account property. Prevents from changing the value once set
Parameters
| Name | Type | Description |
|---|---|---|
game | null | IGame | The game object to set as the account. |
Returns
void
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>
Defined in
create
▸ Static create(options): Promise<HonkaiStarRail>
Create a new instance of HonkaiStarRail using a Hoyolab account.
If uid is not provided in the options, the account with the highest level will be used.
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.
Parameters
| Name | Type | Description |
|---|---|---|
options | IHsrOptions | The options for the HonkaiStarRail instance. |
Returns
Promise<HonkaiStarRail>
- A promise that resolves with a new HonkaiStarRail instance.