Class: HIRecordModule
HIRecordModule class provides methods to interact with Honkai Impact record module endpoints.
Constructors
constructor
• new HIRecordModule(request, lang, region, uid)
Creates an instance of HSRRecordModule.
Parameters
| Name | Type | Description |
|---|---|---|
request | HTTPRequest | The HTTPRequest object used for making API requests. |
lang | LanguageEnum | The language enum value. |
region | null | string | The region string or null if not provided. |
uid | null | number | The UID number or null if not provided. |
Defined in
src/client/hi/record/record.ts:37
Properties
lang
• Private lang: LanguageEnum
The language enum value.
Defined in
src/client/hi/record/record.ts:39
region
• Private region: null | string
The region string or null if not provided.
Defined in
src/client/hi/record/record.ts:40
request
• Private request: HTTPRequest
The HTTPRequest object used for making API requests.
Defined in
src/client/hi/record/record.ts:38
uid
• Private uid: null | number
The UID number or null if not provided.
Defined in
src/client/hi/record/record.ts:41
Methods
abyss
▸ abyss(isOverate?): Promise<IHIAbyss>
Retrieves the abyss information associated with the provided region and UID.
Throws
if the region or UID parameters are missing or failed to be filled.
Throws
if failed to retrieve data, please double-check the provided UID.
Remarks
This method is still in beta, as the response obtained from the server is not yet complete. If you would like to contribute, please send a more complete response by creating a pull request.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
isOverate | boolean | true | is level account is higher 80. |
Returns
Promise<IHIAbyss>
A Promise that resolves to the HI abyss information object.
Defined in
src/client/hi/record/record.ts:148
arena
▸ arena(): Promise<IHIArena>
Retrieves the arena information associated with the provided region and UID.
Throws
if the region or UID parameters are missing or failed to be filled.
Throws
if failed to retrieve data, please double-check the provided UID.
Remarks
This method is still in beta, as the response obtained from the server is not yet complete. If you would like to contribute, please send a more complete response by creating a pull request.
Returns
Promise<IHIArena>
A Promise that resolves to the HI arena information object.
Defined in
src/client/hi/record/record.ts:201
characters
▸ characters(): Promise<IHICharacter[]>
Retrieves the characters associated with the provided region and UID.
Throws
if the region or UID parameters are missing or failed to be filled.
Throws
if failed to retrieve data, please double-check the provided UID.
Returns
Promise<IHICharacter[]>
A Promise that resolves to an array of HI characters.
Defined in
src/client/hi/record/record.ts:97
elysian
▸ elysian(): Promise<IHIElysian>
Retrieves the elysian information associated with the provided region and UID.
Throws
if the region or UID parameters are missing or failed to be filled.
Throws
if failed to retrieve data, please double-check the provided UID.
Remarks
This method is still in beta, as the response obtained from the server is not yet complete. If you would like to contribute, please send a more complete response by creating a pull request.
Returns
Promise<IHIElysian>
A Promise that resolves to the HI elysian information object.
Defined in
src/client/hi/record/record.ts:252
records
▸ records(): Promise<IHIRecord>
Retrieves the records associated with the provided region and UID.
Throws
if the region or UID parameters are missing or failed to be filled.
Throws
if failed to retrieve data, please double-check the provided UID.
Returns
Promise<IHIRecord>
A Promise that resolves to the HI record object.