CachedAssetsManager

Constructors

constructor

new CachedAssetsManager(enka: EnkaClient): CachedAssetsManager

Parameters
- enka: EnkaClient
Returns CachedAssetsManager

Properties

_cacheUpdater

_cacheUpdater: any

_githubCache

_githubCache: any

_isFetching

_isFetching: boolean

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

gameDataBaseUrl

gameDataBaseUrl: string

Base URL for fetching game data

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>

_getExcelData

_getExcelData<T>(excel: T): SingleBy<{ AvatarCodexExcelConfigData: readonly [avatarId]; AvatarCostumeExcelConfigData: readonly [characterId, skinId]; AvatarCurveExcelConfigData: readonly [level]; AvatarExcelConfigData: readonly [id]; AvatarHeroEntityExcelConfigData: readonly [avatarId]; AvatarPromoteExcelConfigData: readonly [avatarPromoteId, readonly [promoteLevel, 0]]; AvatarSkillDepotExcelConfigData: readonly [id]; AvatarSkillExcelConfigData: readonly [id]; AvatarTalentExcelConfigData: readonly [talentId]; EquipAffixExcelConfigData: readonly [id, readonly [level, 0]]; FetterCharacterCardExcelConfigData: readonly [avatarId]; FetterInfoExcelConfigData: readonly [avatarId]; ManualTextMapConfigData: readonly [textMapId]; MaterialExcelConfigData: readonly [id]; ProfilePictureExcelConfigData: readonly [id]; ProudSkillExcelConfigData: readonly [proudSkillGroupId, level]; ReliquaryAffixExcelConfigData: readonly [id]; ReliquaryCodexExcelConfigData: readonly [suitId, level]; ReliquaryExcelConfigData: readonly [id]; ReliquaryLevelExcelConfigData: readonly [readonly [rank, 0], level]; ReliquarySetExcelConfigData: readonly [setId]; RewardExcelConfigData: readonly [rewardId]; RoleCombatDifficultyExcelConfigData: readonly [difficultyId]; TrialAvatarFetterDataConfigData: readonly [avatarId]; WeaponCodexExcelConfigData: readonly [weaponId]; WeaponCurveExcelConfigData: readonly [level]; WeaponExcelConfigData: readonly [id]; WeaponPromoteExcelConfigData: readonly [weaponPromoteId, readonly [promoteLevel, 0]] }[T]>

Type parameters
- T: AvatarExcelConfigData | FetterInfoExcelConfigData | AvatarCostumeExcelConfigData | AvatarSkillDepotExcelConfigData | AvatarSkillExcelConfigData | ProudSkillExcelConfigData | AvatarTalentExcelConfigData | AvatarPromoteExcelConfigData | AvatarCurveExcelConfigData | AvatarCodexExcelConfigData | WeaponExcelConfigData | WeaponPromoteExcelConfigData | WeaponCurveExcelConfigData | WeaponCodexExcelConfigData | EquipAffixExcelConfigData | ReliquaryExcelConfigData | ReliquaryLevelExcelConfigData | ReliquaryAffixExcelConfigData | ReliquarySetExcelConfigData | ReliquaryCodexExcelConfigData | ManualTextMapConfigData | AvatarHeroEntityExcelConfigData | TrialAvatarFetterDataConfigData | MaterialExcelConfigData | FetterCharacterCardExcelConfigData | RewardExcelConfigData | ProfilePictureExcelConfigData | RoleCombatDifficultyExcelConfigData
Parameters
- excel: T
Returns SingleBy<{ AvatarCodexExcelConfigData: readonly [avatarId]; AvatarCostumeExcelConfigData: readonly [characterId, skinId]; AvatarCurveExcelConfigData: readonly [level]; AvatarExcelConfigData: readonly [id]; AvatarHeroEntityExcelConfigData: readonly [avatarId]; AvatarPromoteExcelConfigData: readonly [avatarPromoteId, readonly [promoteLevel, 0]]; AvatarSkillDepotExcelConfigData: readonly [id]; AvatarSkillExcelConfigData: readonly [id]; AvatarTalentExcelConfigData: readonly [talentId]; EquipAffixExcelConfigData: readonly [id, readonly [level, 0]]; FetterCharacterCardExcelConfigData: readonly [avatarId]; FetterInfoExcelConfigData: readonly [avatarId]; ManualTextMapConfigData: readonly [textMapId]; MaterialExcelConfigData: readonly [id]; ProfilePictureExcelConfigData: readonly [id]; ProudSkillExcelConfigData: readonly [proudSkillGroupId, level]; ReliquaryAffixExcelConfigData: readonly [id]; ReliquaryCodexExcelConfigData: readonly [suitId, level]; ReliquaryExcelConfigData: readonly [id]; ReliquaryLevelExcelConfigData: readonly [readonly [rank, 0], level]; ReliquarySetExcelConfigData: readonly [setId]; RewardExcelConfigData: readonly [rewardId]; RoleCombatDifficultyExcelConfigData: readonly [difficultyId]; TrialAvatarFetterDataConfigData: readonly [avatarId]; WeaponCodexExcelConfigData: readonly [weaponId]; WeaponCurveExcelConfigData: readonly [level]; WeaponExcelConfigData: readonly [id]; WeaponPromoteExcelConfigData: readonly [weaponPromoteId, readonly [promoteLevel, 0]] }[T]>

_getExcelDataPath

_getExcelDataPath(excel: AvatarExcelConfigData | FetterInfoExcelConfigData | AvatarCostumeExcelConfigData | AvatarSkillDepotExcelConfigData | AvatarSkillExcelConfigData | ProudSkillExcelConfigData | AvatarTalentExcelConfigData | AvatarPromoteExcelConfigData | AvatarCurveExcelConfigData | AvatarCodexExcelConfigData | WeaponExcelConfigData | WeaponPromoteExcelConfigData | WeaponCurveExcelConfigData | WeaponCodexExcelConfigData | EquipAffixExcelConfigData | ReliquaryExcelConfigData | ReliquaryLevelExcelConfigData | ReliquaryAffixExcelConfigData | ReliquarySetExcelConfigData | ReliquaryCodexExcelConfigData | ManualTextMapConfigData | AvatarHeroEntityExcelConfigData | TrialAvatarFetterDataConfigData | MaterialExcelConfigData | FetterCharacterCardExcelConfigData | RewardExcelConfigData | ProfilePictureExcelConfigData | RoleCombatDifficultyExcelConfigData): string

Parameters
- excel: AvatarExcelConfigData | FetterInfoExcelConfigData | AvatarCostumeExcelConfigData | AvatarSkillDepotExcelConfigData | AvatarSkillExcelConfigData | ProudSkillExcelConfigData | AvatarTalentExcelConfigData | AvatarPromoteExcelConfigData | AvatarCurveExcelConfigData | AvatarCodexExcelConfigData | WeaponExcelConfigData | WeaponPromoteExcelConfigData | WeaponCurveExcelConfigData | WeaponCodexExcelConfigData | EquipAffixExcelConfigData | ReliquaryExcelConfigData | ReliquaryLevelExcelConfigData | ReliquaryAffixExcelConfigData | ReliquarySetExcelConfigData | ReliquaryCodexExcelConfigData | ManualTextMapConfigData | AvatarHeroEntityExcelConfigData | TrialAvatarFetterDataConfigData | MaterialExcelConfigData | FetterCharacterCardExcelConfigData | RewardExcelConfigData | ProfilePictureExcelConfigData | RoleCombatDifficultyExcelConfigData
Returns string

_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: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi): Promise<Record<string, string>>

Obtains a text map for a specific language.
Parameters
- lang: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi
Returns Promise<Record<string, string>>

formatExcel

formatExcel<T>(excel: T, data: FlexJsonObject<JsonOptions, T>[]): SingleBy<{ AvatarCodexExcelConfigData: readonly [avatarId]; AvatarCostumeExcelConfigData: readonly [characterId, skinId]; AvatarCurveExcelConfigData: readonly [level]; AvatarExcelConfigData: readonly [id]; AvatarHeroEntityExcelConfigData: readonly [avatarId]; AvatarPromoteExcelConfigData: readonly [avatarPromoteId, readonly [promoteLevel, 0]]; AvatarSkillDepotExcelConfigData: readonly [id]; AvatarSkillExcelConfigData: readonly [id]; AvatarTalentExcelConfigData: readonly [talentId]; EquipAffixExcelConfigData: readonly [id, readonly [level, 0]]; FetterCharacterCardExcelConfigData: readonly [avatarId]; FetterInfoExcelConfigData: readonly [avatarId]; ManualTextMapConfigData: readonly [textMapId]; MaterialExcelConfigData: readonly [id]; ProfilePictureExcelConfigData: readonly [id]; ProudSkillExcelConfigData: readonly [proudSkillGroupId, level]; ReliquaryAffixExcelConfigData: readonly [id]; ReliquaryCodexExcelConfigData: readonly [suitId, level]; ReliquaryExcelConfigData: readonly [id]; ReliquaryLevelExcelConfigData: readonly [readonly [rank, 0], level]; ReliquarySetExcelConfigData: readonly [setId]; RewardExcelConfigData: readonly [rewardId]; RoleCombatDifficultyExcelConfigData: readonly [difficultyId]; TrialAvatarFetterDataConfigData: readonly [avatarId]; WeaponCodexExcelConfigData: readonly [weaponId]; WeaponCurveExcelConfigData: readonly [level]; WeaponExcelConfigData: readonly [id]; WeaponPromoteExcelConfigData: readonly [weaponPromoteId, readonly [promoteLevel, 0]] }[T]>

Type parameters
- T: AvatarExcelConfigData | FetterInfoExcelConfigData | AvatarCostumeExcelConfigData | AvatarSkillDepotExcelConfigData | AvatarSkillExcelConfigData | ProudSkillExcelConfigData | AvatarTalentExcelConfigData | AvatarPromoteExcelConfigData | AvatarCurveExcelConfigData | AvatarCodexExcelConfigData | WeaponExcelConfigData | WeaponPromoteExcelConfigData | WeaponCurveExcelConfigData | WeaponCodexExcelConfigData | EquipAffixExcelConfigData | ReliquaryExcelConfigData | ReliquaryLevelExcelConfigData | ReliquaryAffixExcelConfigData | ReliquarySetExcelConfigData | ReliquaryCodexExcelConfigData | ManualTextMapConfigData | AvatarHeroEntityExcelConfigData | TrialAvatarFetterDataConfigData | MaterialExcelConfigData | FetterCharacterCardExcelConfigData | RewardExcelConfigData | ProfilePictureExcelConfigData | RoleCombatDifficultyExcelConfigData
Parameters
- excel: T
- data: FlexJsonObject<JsonOptions, T>[]
Returns SingleBy<{ AvatarCodexExcelConfigData: readonly [avatarId]; AvatarCostumeExcelConfigData: readonly [characterId, skinId]; AvatarCurveExcelConfigData: readonly [level]; AvatarExcelConfigData: readonly [id]; AvatarHeroEntityExcelConfigData: readonly [avatarId]; AvatarPromoteExcelConfigData: readonly [avatarPromoteId, readonly [promoteLevel, 0]]; AvatarSkillDepotExcelConfigData: readonly [id]; AvatarSkillExcelConfigData: readonly [id]; AvatarTalentExcelConfigData: readonly [talentId]; EquipAffixExcelConfigData: readonly [id, readonly [level, 0]]; FetterCharacterCardExcelConfigData: readonly [avatarId]; FetterInfoExcelConfigData: readonly [avatarId]; ManualTextMapConfigData: readonly [textMapId]; MaterialExcelConfigData: readonly [id]; ProfilePictureExcelConfigData: readonly [id]; ProudSkillExcelConfigData: readonly [proudSkillGroupId, level]; ReliquaryAffixExcelConfigData: readonly [id]; ReliquaryCodexExcelConfigData: readonly [suitId, level]; ReliquaryExcelConfigData: readonly [id]; ReliquaryLevelExcelConfigData: readonly [readonly [rank, 0], level]; ReliquarySetExcelConfigData: readonly [setId]; RewardExcelConfigData: readonly [rewardId]; RoleCombatDifficultyExcelConfigData: readonly [difficultyId]; TrialAvatarFetterDataConfigData: readonly [avatarId]; WeaponCodexExcelConfigData: readonly [weaponId]; WeaponCurveExcelConfigData: readonly [level]; WeaponExcelConfigData: readonly [id]; WeaponPromoteExcelConfigData: readonly [weaponPromoteId, readonly [promoteLevel, 0]] }[T]>

getExcelData

getExcelData<T, U>(excel: T, ...keys: U): IndexBy<SingleBy<{ AvatarCodexExcelConfigData: readonly [avatarId]; AvatarCostumeExcelConfigData: readonly [characterId, skinId]; AvatarCurveExcelConfigData: readonly [level]; AvatarExcelConfigData: readonly [id]; AvatarHeroEntityExcelConfigData: readonly [avatarId]; AvatarPromoteExcelConfigData: readonly [avatarPromoteId, readonly [promoteLevel, 0]]; AvatarSkillDepotExcelConfigData: readonly [id]; AvatarSkillExcelConfigData: readonly [id]; AvatarTalentExcelConfigData: readonly [talentId]; EquipAffixExcelConfigData: readonly [id, readonly [level, 0]]; FetterCharacterCardExcelConfigData: readonly [avatarId]; FetterInfoExcelConfigData: readonly [avatarId]; ManualTextMapConfigData: readonly [textMapId]; MaterialExcelConfigData: readonly [id]; ProfilePictureExcelConfigData: readonly [id]; ProudSkillExcelConfigData: readonly [proudSkillGroupId, level]; ReliquaryAffixExcelConfigData: readonly [id]; ReliquaryCodexExcelConfigData: readonly [suitId, level]; ReliquaryExcelConfigData: readonly [id]; ReliquaryLevelExcelConfigData: readonly [readonly [rank, 0], level]; ReliquarySetExcelConfigData: readonly [setId]; RewardExcelConfigData: readonly [rewardId]; RoleCombatDifficultyExcelConfigData: readonly [difficultyId]; TrialAvatarFetterDataConfigData: readonly [avatarId]; WeaponCodexExcelConfigData: readonly [weaponId]; WeaponCurveExcelConfigData: readonly [level]; WeaponExcelConfigData: readonly [id]; WeaponPromoteExcelConfigData: readonly [weaponPromoteId, readonly [promoteLevel, 0]] }[T]>, U>

Type parameters
- T: AvatarExcelConfigData | FetterInfoExcelConfigData | AvatarCostumeExcelConfigData | AvatarSkillDepotExcelConfigData | AvatarSkillExcelConfigData | ProudSkillExcelConfigData | AvatarTalentExcelConfigData | AvatarPromoteExcelConfigData | AvatarCurveExcelConfigData | AvatarCodexExcelConfigData | WeaponExcelConfigData | WeaponPromoteExcelConfigData | WeaponCurveExcelConfigData | WeaponCodexExcelConfigData | EquipAffixExcelConfigData | ReliquaryExcelConfigData | ReliquaryLevelExcelConfigData | ReliquaryAffixExcelConfigData | ReliquarySetExcelConfigData | ReliquaryCodexExcelConfigData | ManualTextMapConfigData | AvatarHeroEntityExcelConfigData | TrialAvatarFetterDataConfigData | MaterialExcelConfigData | FetterCharacterCardExcelConfigData | RewardExcelConfigData | ProfilePictureExcelConfigData | RoleCombatDifficultyExcelConfigData
- U: (string | number)[]
Parameters
- excel: T
- rest...keys: U
Returns IndexBy<SingleBy<{ AvatarCodexExcelConfigData: readonly [avatarId]; AvatarCostumeExcelConfigData: readonly [characterId, skinId]; AvatarCurveExcelConfigData: readonly [level]; AvatarExcelConfigData: readonly [id]; AvatarHeroEntityExcelConfigData: readonly [avatarId]; AvatarPromoteExcelConfigData: readonly [avatarPromoteId, readonly [promoteLevel, 0]]; AvatarSkillDepotExcelConfigData: readonly [id]; AvatarSkillExcelConfigData: readonly [id]; AvatarTalentExcelConfigData: readonly [talentId]; EquipAffixExcelConfigData: readonly [id, readonly [level, 0]]; FetterCharacterCardExcelConfigData: readonly [avatarId]; FetterInfoExcelConfigData: readonly [avatarId]; ManualTextMapConfigData: readonly [textMapId]; MaterialExcelConfigData: readonly [id]; ProfilePictureExcelConfigData: readonly [id]; ProudSkillExcelConfigData: readonly [proudSkillGroupId, level]; ReliquaryAffixExcelConfigData: readonly [id]; ReliquaryCodexExcelConfigData: readonly [suitId, level]; ReliquaryExcelConfigData: readonly [id]; ReliquaryLevelExcelConfigData: readonly [readonly [rank, 0], level]; ReliquarySetExcelConfigData: readonly [setId]; RewardExcelConfigData: readonly [rewardId]; RoleCombatDifficultyExcelConfigData: readonly [difficultyId]; TrialAvatarFetterDataConfigData: readonly [avatarId]; WeaponCodexExcelConfigData: readonly [weaponId]; WeaponCurveExcelConfigData: readonly [level]; WeaponExcelConfigData: readonly [id]; WeaponPromoteExcelConfigData: readonly [weaponPromoteId, readonly [promoteLevel, 0]] }[T]>, U>

getJSONDataPath

getJSONDataPath(name: string): string

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

getLanguageData

getLanguageData(lang: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi, directory?: string): JsonObject<string>

Parameters
- lang: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi
- optionaldirectory: string
Returns JsonObject<string>
text map for a specific language

getLanguageDataPath

getLanguageDataPath(lang: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi, directory?: string): string

Parameters
- lang: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi
- 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: LoadedExcelDataMap, langsData: LoadedLanguageMap, showLog?: boolean): LoadedLanguageMap

Remove all unused text map entries
Parameters
- data: LoadedExcelDataMap
- langsData: LoadedLanguageMap
- showLog: boolean = true
Returns LoadedLanguageMap

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.

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

enka: EnkaClient

Returns CachedAssetsManager

Properties

_cacheUpdater

_githubCache

_isFetching

cacheDirectoryPath

readonlydefaultCacheDirectoryPath

readonlyenka

gameDataBaseUrl

Methods

_downloadCacheZip

Parameters

options: { ghproxy?: boolean } = {}

Returns Promise<void>

_getExcelData

Type parameters

Parameters

excel: T

_getExcelDataPath

Parameters

Returns string

_validateCache

Parameters

showLog: boolean = true

Returns boolean

activateAutoCacheUpdater

Parameters

options: Partial<AutoCacheUpdaterOptions> = {}

Returns void

cacheDirectorySetup

Returns Promise<void>

checkForUpdates

Parameters

useRawGenshinData: boolean = false

Returns Promise<boolean>

deactivateAutoCacheUpdater

Returns void

fetchAllContents

Parameters

options: Partial<FetchContentsOptions> = {}

Returns Promise<void>

fetchLanguageData

Parameters

lang: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi

Returns Promise<Record<string, string>>

formatExcel

Type parameters

Parameters

excel: T

data: FlexJsonObject<JsonOptions, T>[]

getExcelData

Type parameters

Parameters

excel: T

rest...keys: U

getJSONDataPath

Parameters

name: string

Returns string

getLanguageData

Parameters

lang: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi

optionaldirectory: string

Returns JsonObject<string>

getLanguageDataPath

Parameters

lang: id | chs | cht | de | en | es | fr | jp | kr | pt | ru | th | vi

optionaldirectory: string

Returns string

getObjectKeysManager

Returns ObjectKeysManager

hasAllContents