Class: HSRWiki
HIRecordModule class provides methods to interact with Honkai Impact record module endpoints.
Constructors
constructor
• new HSRWiki(lang)
Creates an instance of HSRWikiModule.
Parameters
| Name | Type | Description |
|---|---|---|
lang | LanguageEnum | The language enum value. |
Defined in
src/client/hoyowiki/games/hsr/HSRWiki.ts:39
Properties
request
• Private Readonly request: HTTPRequest
The underlying Request object used to make HTTP requests.
Defined in
src/client/hoyowiki/games/hsr/HSRWiki.ts:32
Methods
characterDetail
▸ characterDetail(id): Promise<HSR_Wiki_Character_Detail>
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.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The character ID. |
Returns
Promise<HSR_Wiki_Character_Detail>
A Promise that resolves to Character Detail.
Defined in
src/client/hoyowiki/games/hsr/HSRWiki.ts:140
characters
▸ characters(page_num?, page_size?): Promise<HSR_Wiki_Charaters[]>
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.
Parameters
| Name | Type | Default value |
|---|---|---|
page_num | number | 1 |
page_size | number | 30 |
Returns
Promise<HSR_Wiki_Charaters[]>
A Promise that resolves to an array of HSR characters.
Defined in
src/client/hoyowiki/games/hsr/HSRWiki.ts:94
lightConeDetail
▸ lightConeDetail(id): Promise<HSR_Wiki_LightCone_Detail>
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.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The Light Cone ID. |
Returns
Promise<HSR_Wiki_LightCone_Detail>
A Promise that resolves to Light Cone Detail.
Defined in
src/client/hoyowiki/games/hsr/HSRWiki.ts:225
lightCones
▸ lightCones(page_num?, page_size?): Promise<HSR_Wiki_LightCones[]>
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.
Parameters
| Name | Type | Default value |
|---|---|---|
page_num | number | 1 |
page_size | number | 30 |
Returns
Promise<HSR_Wiki_LightCones[]>
A Promise that resolves to an array of HSR light cones.
Defined in
src/client/hoyowiki/games/hsr/HSRWiki.ts:179
menuFilters
▸ menuFilters(id?): Promise<HSR_Wiki_MenuFilter[]>
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.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
id | HSRMenuEnum | HSRMenuEnum.CHARACTER | The menu filter ID. |
Returns
Promise<HSR_Wiki_MenuFilter[]>
A Promise that resolves to an array of HSR menu filters.
Defined in
src/client/hoyowiki/games/hsr/HSRWiki.ts:53
relicDetail
▸ relicDetail(id): Promise<HSR_Wiki_Relic_Detail>
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.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The Relic ID. |
Returns
Promise<HSR_Wiki_Relic_Detail>
A Promise that resolves to Relic Detail.
Defined in
src/client/hoyowiki/games/hsr/HSRWiki.ts:310
relics
▸ relics(page_num?, page_size?): Promise<HSR_Wiki_Relics[]>
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.
Parameters
| Name | Type | Default value |
|---|---|---|
page_num | number | 1 |
page_size | number | 30 |
Returns
Promise<HSR_Wiki_Relics[]>
A Promise that resolves to an array of HSR Relics.