Class ReadRS

constructor

• new ReadRS(fs?): ReadRS

• 构建可读资源系统

  Parameters

  • Optional fs: ReadFS

    可读文件系统

  Returns ReadRS

Static rs

fs

• get fs(): ReadFS

• 文件系统

  Returns ReadFS

root

• get root(): FolderAsset

• 根资源

  Returns FolderAsset

rootPath

• get rootPath(): string

• 根资源路径

  Returns string

addAsset

• addAsset(asset): void

• 新增资源

  Parameters

  • asset: FileAsset

    资源

  Returns void

createAsset

• createAsset<T>(Cls, fileName?, value?, parent?): Promise<FileAsset>

• 新建资源

  Type Parameters

  • T extends FileAsset<T>

  Parameters

  • Cls: (new () => T)

    资源类定义

    • • new (): T

      • Returns T

  • Optional fileName: string

    文件名称

  • Optional value: gPartial<T>

    初始数据

  • Optional parent: FolderAsset

    所在文件夹，如果值为null时默认添加到根文件夹中

  Returns Promise<FileAsset>

deleteAsset0

• deleteAsset0(asset): void

• 删除资源

  Parameters

  • asset: FileAsset

    资源

  Returns void

deleteAssetById

• deleteAssetById(id): void

• 删除指定编号的资源

  Parameters

  • id: string

    资源编号

  Returns void

deleteAssetByPath

• deleteAssetByPath(path): void

• 删除指定路径的资源

  Parameters

  • path: string

    资源路径

  Returns void

deserializeWithAssets

• deserializeWithAssets(object): Promise<any>

• 反序列化包含资源的对象

  Parameters

  • object: any

    反序列化的对象

  Returns Promise<any>

getAllAssets

• getAllAssets(): FileAsset[]

• 获取所有资源

  Returns FileAsset[]

getAllIds

• getAllIds(): string[]

• 获取所有资源编号列表

  Returns string[]

getAllPaths

• getAllPaths(): string[]

• 获取所有资源路径列表

  Returns string[]

getAssetById

• getAssetById(id): FileAsset

• 获取指定编号资源

  Parameters

  • id: string

    资源编号

  Returns FileAsset

getAssetByPath

• getAssetByPath(path): FileAsset

• 获取指定路径资源

  Parameters

  • path: string

    资源路径

  Returns FileAsset

getAssetsByType

• getAssetsByType<T>(type): T[]

• 获取指定类型资源

  Type Parameters

  • T extends FileAsset<T>

  Parameters

  • type: Constructor<T>

    资源类型

  Returns T[]

getAssetsWithObject

• getAssetsWithObject(object, assetids?): string[]

• 获取需要反序列化对象中的资源id列表

  Parameters

  • object: any

  • Optional assetids: string[]

  Returns string[]

getChildrenAssetByPath

• getChildrenAssetByPath(path): FileAsset[]

• 获取文件夹内子文件列表

  Parameters

  • path: string

    文件夹路径

  Returns FileAsset[]

getChildrenPathsByPath

• getChildrenPathsByPath(p): string[]

• 获取文件夹内子文件路径列表

  Parameters

  • p: string

  Returns string[]

getLoadedAssetDatasByType

• getLoadedAssetDatasByType<T>(type): T[]

• 获取指定类型资源数据

  Type Parameters

  • T

  Parameters

  • type: Constructor<T>

    资源类型

  Returns T[]

getValidChildName

• getValidChildName(parent, fileName): string

• 获取有效子文件名称

  Parameters

  • parent: FolderAsset

    父文件夹

  • fileName: string

    文件名称

  Returns string

init

• init(): Promise<void>

• 初始化

  Returns Promise<void>

readAsset

• readAsset(id): Promise<FileAsset>

• 读取文件为资源对象

  Parameters

  • id: string

    资源编号

  Returns Promise<FileAsset>

readAssetData

• readAssetData(id): Promise<any>

• 读取资源数据

  Parameters

  • id: string

    资源编号

  Returns Promise<any>

readAssetDatas

• readAssetDatas(assetids): Promise<AssetData[]>

• 读取资源数据列表

  Parameters

  • assetids: string[]

    资源编号列表

  Returns Promise<AssetData[]>