Skip to main content

CachedAssetsManager

Constructors

constructor

new CachedAssetsManager(enka: EnkaClient): CachedAssetsManager

Parameters
- enka: EnkaClient
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 genshin cache data is stored

readonlydefaultCacheDirectoryPath

defaultCacheDirectoryPath: string

Default path of genshin cache data directory

readonlyenka

enka: EnkaClient

The client that instantiated this

Methods

_downloadCacheZip

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

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

_validateCache

_validateCache(showLog?: boolean): boolean

Parameters
- showLog: boolean = true
Returns boolean
whether the cache is valid or not

activateAutoCacheUpdater

activateAutoCacheUpdater(options?: Partial<AutoCacheUpdaterOptions>): void

Parameters
- options: Partial<AutoCacheUpdaterOptions> = {}
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(useRawGenshinData?: boolean): Promise<boolean>

Parameters
- useRawGenshinData: boolean = false
  Whether to fetch from gitlab repo (https://gitlab.com/Dimbreath/AnimeGameData) 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?: Partial<FetchContentsOptions>): Promise<void>

Parameters
- options: Partial<FetchContentsOptions> = {}
Returns Promise<void>

fetchLanguageData

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

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

getGenshinCacheData

getGenshinCacheData(name: string): JsonReader

Parameters
- name: string
  without extensions (.json)
Returns JsonReader

getJSONDataPath

getJSONDataPath(name: string): string

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

getLanguageData

getLanguageData(lang: LanguageCode, directory?: string): {}

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

getLanguageDataPath

getLanguageDataPath(lang: LanguageCode, directory?: string): string

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

getObjectKeysManager

getObjectKeysManager(): ObjectKeysManager

Returns ObjectKeysManager
ObjectKeysManager of this

hasAllContents

hasAllContents(): boolean

Returns boolean
whether all genshin 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): { langMap: LanguageMap; voiceLangMap: LanguageMap }

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

updateContents

updateContents(options?: Partial<UpdateContentsOptions>): Promise<void>

Parameters
- options: Partial<UpdateContentsOptions> = {}
Returns Promise<void>
true if there were any updates, false if there were no updates.