Class AssetFileMap

AssetFileMap handles file path based asset list.

Hierarchy

AssetFileMap

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AssetFileMap(assetRoot: string): AssetFileMap

- Defined in asset/AssetFileMap.ts:17
Constructor throws exception when given path is invalid as absolute path.

Parameters
- assetRoot: string
Returns AssetFileMap

Properties

Private assetRoot

assetRoot: string

Asset root path.

Private entities

entities: Map<string, AssetFileEntity>

Map of AssetFileEntity related to absolute path.

Methods

clear

clear(): void

- Defined in asset/AssetFileMap.ts:33
Clear AssetFileEntity map.

Returns void

forEach

forEach(proc: function): void

- Defined in asset/AssetFileMap.ts:47
Wrapper for entities.forEach() to keep it readonly.

Parameters
- proc: function
  - - (entity: AssetFileEntity, key: string): void
    - Parameters
      - entity: AssetFileEntity
      - key: string
      Returns void
Returns void

get

get(key: string): AssetFileEntity | undefined

- Defined in asset/AssetFileMap.ts:40
Wrapper for entities.get() to keep it readonly.

Parameters
- key: string
Returns AssetFileEntity | undefined

scan

scan(targetPath?: string): void

- Defined in asset/AssetFileMap.ts:54
Scan given path and set entities.

Parameters
- Default value targetPath: string = this.assetRoot
Returns void

Generated using TypeDoc