StarRail

Implements

• unknown<StarRailUser, StarRailCharacterBuild>

Index

Constructors

• constructor

Properties

• cachedAssetsManager
• hoyoType
• options

Methods

• close
• fetchEnkaStarRailAccount
• fetchEnkaStarRailAccounts
• fetchEnkaStarRailBuilds
• fetchUser
• getAllCharacters
• getAllLightCones
• getAllRelics
• getCharacterBuild
• getUser

Constructors

constructor

• new StarRail(options: Partial<ClientOptions>): StarRail

• Parameters

  • options: Partial<ClientOptions>

  Returns StarRail

Properties

readonlycachedAssetsManager

cachedAssetsManager: CachedAssetsManager

readonlyhoyoType

hoyoType: 1

readonlyoptions

options: ClientOptions

The options the client was instantiated with

Methods

close

• close(): void

• Clear all running tasks in the client.

  ---

  Returns void

fetchEnkaStarRailAccount

• fetchEnkaStarRailAccount(username: string, hash: string): Promise<EnkaGameAccount<StarRail>>

• ---

  Parameters

  • username: string

    enka.network username, not in-game nickname

  • hash: string

    EnkaGameAccount hash

  Returns Promise<EnkaGameAccount<StarRail>>

  the starrail account with provided hash

fetchEnkaStarRailAccounts

• fetchEnkaStarRailAccounts(username: string): Promise<EnkaGameAccount<StarRail>[]>

• ---

  Parameters

  • username: string

    enka.network username, not in-game nickname

  Returns Promise<EnkaGameAccount<StarRail>[]>

  the starrail accounts added to the Enka.Network account

fetchEnkaStarRailBuilds

• fetchEnkaStarRailBuilds(username: string, hash: string): Promise<{}>

• ---

  Parameters

  • username: string

    enka.network username, not in-game nickname

  • hash: string

    EnkaGameAccount hash

  Returns Promise<{}>

  the starrail character builds including saved builds in Enka.Network account

fetchUser

• fetchUser(uid: string | number, options?: Partial<FetchOptions>): Promise<StarRailUser>

• @throws

  ---

  Parameters

  • uid: string | number

  • options: Partial<FetchOptions> = {}

  Returns Promise<StarRailUser>

getAllCharacters

• getAllCharacters(playableOnly?: boolean): CharacterData[]

• ---

  Parameters

  • playableOnly: boolean = true

  Returns CharacterData[]

  all character data

getAllLightCones

• getAllLightCones(excludeTestLightCones?: boolean): LightConeData[]

• ---

  Parameters

  • excludeTestLightCones: boolean = true

  Returns LightConeData[]

  all light cone data

getAllRelics

• getAllRelics(): RelicData[]

• ---

  Returns RelicData[]

  all relic data

getCharacterBuild

• getCharacterBuild(data: JsonObject, username: string, hash: string): StarRailCharacterBuild

• Parameters

  • data: JsonObject

  • username: string

  • hash: string

  Returns StarRailCharacterBuild

getUser

• getUser(data: JsonObject): StarRailUser

• Parameters

  • data: JsonObject

  Returns StarRailUser