StarRail
class StarRail implements EnkaLibrary<StarRailUser, StarRailCharacterBuild>
Properties
Methods
constructor
new StarRail(options)
| PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| options | Partial<ClientOptions> |
Properties
options
The options the client was instantiated with
Type: ClientOptions
cachedAssetsManager
Type: CachedAssetsManager
Methods
fetchUser
async
Returns: Promise<StarRailUser>
| PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| uid | number | string |
Throws: EnkaNetworkError
fetchEnkaStarRailAccounts
async
Returns: Promise<EnkaGameAccount<StarRail>[]>
- the starrail accounts added to the Enka.Network account
| PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| username | string | enka.network username, not in-game nickname |
fetchEnkaStarRailAccount
async
Returns: Promise<EnkaGameAccount<StarRail>>
- the starrail account with provided hash
| PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| username | string | enka.network username, not in-game nickname | ||
| hash | string | EnkaGameAccount hash |
fetchEnkaStarRailBuilds
async
Returns: Promise<{[characterId: string]: StarRailCharacterBuild[]}>
- the starrail character builds including saved builds in Enka.Network account
| PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| username | string | enka.network username, not in-game nickname | ||
| hash | string | EnkaGameAccount hash |
getAllCharacters
Returns: CharacterData[]
- all character data
| PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| playableOnly | ✔️ | true |
getAllLightCones
Returns: LightConeData[]
- all light cone data
| PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| excludeTestLightCones | ✔️ | true |
getAllRelics
Returns: RelicData[]
- all relic data