Skip to main content

StarRail

class StarRail

constructor

new StarRail(options)
PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
optionsPartial<ClientOptions>

Properties

options

The options the client was instantiated with

Type: ClientOptions


cachedAssetsManager

Type: CachedAssetsManager


Methods

fetchUser

async

Returns: Promise<User>

PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
uidnumber | string

getAllCharacters

Returns: CharacterData[]

  • all character data
PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
playableOnly✔️true

getAllLightCones

Returns: LightConeData[]

  • all light cone data
PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
excludeTestLightCones✔️true

getAllRelics

Returns: RelicData[]

  • all relic data