Class ReadWriteRS

可读写资源系统

Hierarchy

ReadRS
- ReadWriteRS

Constructors

constructor

new ReadWriteRS(fs?: ReadWriteFS): ReadWriteRS
构建可读写资源系统
Parameters
- Optional fs: ReadWriteFS
  
  可读写文件系统
Returns ReadWriteRS
Inherited from ReadRS.constructor
- Defined in src/assets/rs/ReadWriteRS.ts:34

Properties

`Protected` _idMap

_idMap: {
[id: string]: FileAsset;
} = {}

资源编号映射

Type declaration

[id: string]: FileAsset

`Protected` _pathMap

_pathMap: {
[path: string]: FileAsset;
} = {}

资源路径映射

Type declaration

[path: string]: FileAsset

`Protected` resources

resources: string = 'resource.json'

资源树保存路径

`Static` rs

rs: ReadRS = ...

默认资源系统

Accessors

fs

get fs(): ReadWriteFS
文件系统

Returns ReadWriteFS
- Defined in src/assets/rs/ReadWriteRS.ts:12

root

get root(): FolderAsset
根资源

Returns FolderAsset
- Defined in src/assets/rs/ReadRS.ts:41

rootPath

get rootPath(): string
根资源路径

Returns string
- Defined in src/assets/rs/ReadRS.ts:35

Methods

addAsset

addAsset(asset: FileAsset): void
新增资源
Parameters
- asset: FileAsset
  
  资源
Returns void
Inherited from ReadRS.addAsset
- Defined in src/assets/rs/ReadRS.ts:299

createAsset

createAsset<T>(cls: (new () => T), fileName?: string, value?: gPartial<T>, parent?: FolderAsset): 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>
Inherited from ReadRS.createAsset
- Defined in src/assets/rs/ReadWriteRS.ts:57

deleteAsset

deleteAsset(asset: FileAsset): Promise<void>
删除资源
Parameters
- asset: FileAsset
  
  资源
Returns Promise<void>
- Defined in src/assets/rs/ReadWriteRS.ts:155

deleteAsset0

deleteAsset0(asset: FileAsset): void
删除资源
Parameters
- asset: FileAsset
  
  资源
Returns void
Inherited from ReadRS.deleteAsset0
- Defined in src/assets/rs/ReadRS.ts:356

deleteAssetById

deleteAssetById(id: string): void
删除指定编号的资源
Parameters
- id: string
  
  资源编号
Returns void
Inherited from ReadRS.deleteAssetById
- Defined in src/assets/rs/ReadRS.ts:336

deleteAssetByPath

deleteAssetByPath(path: string): void
删除指定路径的资源
Parameters
- path: string
  
  资源路径
Returns void
Inherited from ReadRS.deleteAssetByPath
- Defined in src/assets/rs/ReadRS.ts:346

deserializeWithAssets

deserializeWithAssets(object: any): Promise<any>
反序列化包含资源的对象
Parameters
- object: any
  
  反序列化的对象
Returns Promise<any>
Inherited from ReadRS.deserializeWithAssets
- Defined in src/assets/rs/ReadRS.ts:388

getAllAssets

getAllAssets(): FileAsset[]
获取所有资源

Returns FileAsset[]
Inherited from ReadRS.getAllAssets
- Defined in src/assets/rs/ReadRS.ts:324

getAllIds

getAllIds(): string[]
获取所有资源编号列表

Returns string[]
Inherited from ReadRS.getAllIds
- Defined in src/assets/rs/ReadRS.ts:308

getAllPaths

getAllPaths(): string[]
获取所有资源路径列表

Returns string[]
Inherited from ReadRS.getAllPaths
- Defined in src/assets/rs/ReadRS.ts:316

getAssetById

getAssetById(id: string): FileAsset
获取指定编号资源
Parameters
- id: string
  
  资源编号
Returns FileAsset
Inherited from ReadRS.getAssetById
- Defined in src/assets/rs/ReadRS.ts:251

getAssetByPath

getAssetByPath(path: string): FileAsset
获取指定路径资源
Parameters
- path: string
  
  资源路径
Returns FileAsset
Inherited from ReadRS.getAssetByPath
- Defined in src/assets/rs/ReadRS.ts:261

getAssetsByType

getAssetsByType<T>(type: Constructor<T>): T[]
获取指定类型资源
Type Parameters
- T extends FileAsset<T>
Parameters
- type: Constructor<T>
  
  资源类型
Returns T[]
Inherited from ReadRS.getAssetsByType
- Defined in src/assets/rs/ReadRS.ts:227

getAssetsWithObject

getAssetsWithObject(object: any, assetids?: string[]): string[]
获取需要反序列化对象中的资源id列表
Parameters
- object: any
- assetids: string[] = []
Returns string[]
Inherited from ReadRS.getAssetsWithObject
- Defined in src/assets/rs/ReadRS.ts:365

getChildrenAssetByPath

getChildrenAssetByPath(path: string): FileAsset[]
获取文件夹内子文件列表
Parameters
- path: string
  
  文件夹路径
Returns FileAsset[]
Inherited from ReadRS.getChildrenAssetByPath
- Defined in src/assets/rs/ReadRS.ts:285

getChildrenPathsByPath

getChildrenPathsByPath(path: string): string[]
获取文件夹内子文件路径列表
Parameters
- path: string
  
  路径
Returns string[]
Inherited from ReadRS.getChildrenPathsByPath
- Defined in src/assets/rs/ReadRS.ts:271

getLoadedAssetDatasByType

getLoadedAssetDatasByType<T>(type: Constructor<T>): T[]
获取指定类型资源数据
Type Parameters
- T
Parameters
- type: Constructor<T>
  
  资源类型
Returns T[]
Inherited from ReadRS.getLoadedAssetDatasByType
- Defined in src/assets/rs/ReadRS.ts:239

getValidChildName

getValidChildName(parent: FolderAsset, fileName: string): string
获取有效子文件名称
Parameters
- parent: FolderAsset
  
  父文件夹
- fileName: string
  
  文件名称
Returns string
Inherited from ReadRS.getValidChildName
- Defined in src/assets/rs/ReadRS.ts:158

init

init(): Promise<void>
初始化

Returns Promise<void>
Inherited from ReadRS.init
- Defined in src/assets/rs/ReadRS.ts:71

`Private` laterSave

laterSave(): void
延迟保存，避免多次操作时频繁调用保存

Returns void
- Defined in src/assets/rs/ReadWriteRS.ts:27

`Private` laterSaveFunc

laterSaveFunc(_interval: number): void
延迟保存执行函数
Parameters
- _interval: number
Returns void
- Defined in src/assets/rs/ReadWriteRS.ts:23

moveAsset

moveAsset(asset: FileAsset, folder: FolderAsset): Promise<void>
移动资源到指定文件夹
Parameters
- asset: FileAsset
  
  被移动资源
- folder: FolderAsset
  
  目标文件夹
Returns Promise<void>
- Defined in src/assets/rs/ReadWriteRS.ts:86

readAsset

readAsset(id: string): Promise<FileAsset>
读取文件为资源对象
Parameters
- id: string
  
  资源编号
Returns Promise<FileAsset>
Inherited from ReadRS.readAsset
- Defined in src/assets/rs/ReadRS.ts:176

readAssetData

readAssetData(id: string): Promise<any>
读取资源数据
Parameters
- id: string
  
  资源编号
Returns Promise<any>
Inherited from ReadRS.readAssetData
- Defined in src/assets/rs/ReadRS.ts:196

readAssetDatas

readAssetDatas(assetids: string[]): Promise<AssetData[]>
读取资源数据列表
Parameters
- assetids: string[]
  
  资源编号列表
Returns Promise<AssetData[]>
Inherited from ReadRS.readAssetDatas
- Defined in src/assets/rs/ReadRS.ts:215

`Private` save

save(): Promise<void>
在更改资源结构（新增，移动，删除）时会自动保存

Returns Promise<void>
- Defined in src/assets/rs/ReadWriteRS.ts:42

writeAsset

writeAsset(asset: FileAsset): Promise<void>
写（保存）资源
Parameters
- asset: FileAsset
  
  资源对象
Returns Promise<void>
- Defined in src/assets/rs/ReadWriteRS.ts:75

Class ReadWriteRS

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional fs: ReadWriteFS

Returns ReadWriteRS

Properties

Protected _idMap

Type declaration

[id: string]: FileAsset

Protected _pathMap

Type declaration

[path: string]: FileAsset

Protected resources

Static rs

Accessors

fs

Returns ReadWriteFS

root

Returns FolderAsset

rootPath

Returns string

Methods

addAsset

Parameters

asset: FileAsset

Returns void

createAsset

Type Parameters

T extends FileAsset<T>

Parameters

cls: (new () => T)

Returns T

Optional fileName: string

Optional value: gPartial<T>

Optional parent: FolderAsset

Returns Promise<FileAsset>

deleteAsset

Parameters

asset: FileAsset

Returns Promise<void>

deleteAsset0

Parameters

asset: FileAsset

Returns void

deleteAssetById

Parameters

id: string

Returns void

deleteAssetByPath

Parameters

path: string

Returns void

deserializeWithAssets

Parameters

object: any

Returns Promise<any>

getAllAssets

Returns FileAsset[]

getAllIds

Returns string[]

getAllPaths

Returns string[]

getAssetById

Parameters

id: string

Returns FileAsset

getAssetByPath

Parameters

path: string

Returns FileAsset

getAssetsByType

Type Parameters

T extends FileAsset<T>

`Optional` fs: ReadWriteFS

`Protected` _idMap

`Protected` _pathMap

`Protected` resources

`Static` rs

`Optional` fileName: string

`Optional` value: gPartial<T>

`Optional` parent: FolderAsset

`Private` laterSave

`Private` laterSaveFunc

`Private` save