StarRail
class StarRail
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<User>
| PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| uid | number | string |
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