Skip to main content

CachedAssetsManager

Constructors

constructor

new CachedAssetsManager(client: StarRail): CachedAssetsManager

Parameters
- client: StarRail
Returns CachedAssetsManager

Properties

_cacheUpdater

_cacheUpdater: any

readonly_contentsSrc

_contentsSrc: string[]

List of the names of the files this library uses

_githubCache

_githubCache: any

_isFetching

_isFetching: boolean

readonly_langs

_langs: string[]

List of supported languages

cacheDirectoryPath

cacheDirectoryPath: string

Path of directory where StarRail cache data is stored

readonlyclient

client: StarRail

The client that instantiated this

readonlydefaultCacheDirectoryPath

defaultCacheDirectoryPath: string

Default path of StarRail cache data directory

Methods

_downloadCacheZip

_downloadCacheZip(options?: { ghproxy?: boolean }): Promise<void>

Download the zip file, which contains StarRail cache data, from https://raw.githubusercontent.com/yuko1101/starrail.js/main/cache.zip
Parameters
- options: { ghproxy?: boolean } = {}
Returns Promise<void>

activateAutoCacheUpdater

activateAutoCacheUpdater(options?: { ghproxy?: boolean; instant?: boolean; onError?: (error: Error) => Promise<void>; onUpdateEnd?: () => Promise<void>; onUpdateStart?: () => Promise<void>; timeout?: number; useRawStarRailData?: boolean }): void

Parameters
- options: { ghproxy?: boolean; instant?: boolean; onError?: (error: Error) => Promise<void>; onUpdateEnd?: () => Promise<void>; onUpdateStart?: () => Promise<void>; timeout?: number; useRawStarRailData?: boolean } = {}
Returns void

cacheDirectorySetup

cacheDirectorySetup(): Promise<void>

Create the necessary folders and files, and if the directory cacheDirectoryPath did not exist, move the cache files from the default path.
Returns Promise<void>

checkForUpdates

checkForUpdates(useRawStarRailData?: boolean): Promise<boolean>

Parameters
- useRawStarRailData: boolean = false
  Whether to fetch from github repo (https://github.com/Dimbreath/StarRailData) instead of downloading cache.zip
Returns Promise<boolean>
Whether the game data update is available or not.

deactivateAutoCacheUpdater

deactivateAutoCacheUpdater(): void

Disables the updater activated by activateAutoCacheUpdater
Returns void

fetchAllContents

fetchAllContents(options: { ghproxy?: boolean; useRawStarRailData?: boolean }): Promise<void>

Parameters
- options: { ghproxy?: boolean; useRawStarRailData?: boolean }
Returns Promise<void>

fetchLanguageData

fetchLanguageData(lang: LanguageCode): Promise<{}>

Obtains a text map for a specific language.
Parameters
- lang: LanguageCode
Returns Promise<{}>

getJSONDataPath

getJSONDataPath(name: string): string

Parameters
- name: string
  without extensions (.json)
Returns string
excel bin file path

getLanguageData

getLanguageData(lang: LanguageCode): {}

Parameters
- lang: LanguageCode
Returns {}
text map for a specific language
- [key string]: string

getLanguageDataPath

getLanguageDataPath(lang: LanguageCode): string

Parameters
- lang: LanguageCode
Returns string
text map file path for a specific language

getObjectKeysManager

getObjectKeysManager(): ObjectKeysManager

Returns ObjectKeysManager
ObjectKeysManager of this

getStarRailCacheData

getStarRailCacheData(name: string): {}

Parameters
- name: string
  without extensions (.json)
Returns {}
- [key string]: JsonObject

hasAllContents

hasAllContents(): boolean

Returns boolean
whether all StarRail cache data files exist.

refreshAllData

refreshAllData(reload?: boolean): void

Clean memory of cache data. Then reload data that was loaded before the clean if reload is true. If reload is false, load each file as needed.
Parameters
- reload: boolean = false
Returns void

removeUnusedTextData

removeUnusedTextData(data: {}, langsData: LanguageMap, showLog?: boolean): LanguageMap

Remove all unused text map entries
Parameters
- data: {}
- langsData: LanguageMap
- showLog: boolean = true
Returns LanguageMap

updateContents

updateContents(options?: { ghproxy?: boolean; onUpdateEnd?: () => Promise<void>; onUpdateStart?: () => Promise<void>; useRawStarRailData?: boolean }): Promise<void>

Parameters
- options: { ghproxy?: boolean; onUpdateEnd?: () => Promise<void>; onUpdateStart?: () => Promise<void>; useRawStarRailData?: boolean } = {}
Returns Promise<void>
true if there were any updates, false if there were no updates.