Class LoadCache<Data>

Shared resource cache with event-backed pending request coordination.

Type Parameters

Data = unknown

Hierarchy (View Summary)

EventDispatcher
- LoadCache

Index

Constructors

Properties

_listeners className enabled isLoadCache FAILED LOADED PENDING

Methods

clear fire get getLoaded off on remove update wait

Constructors

constructor

new LoadCache<Data = unknown>(): LoadCache<Data>
Type Parameters
- Data = unknown
Returns LoadCache<Data>

Inherited from EventDispatcher.constructor

Properties

_listeners

_listeners: ListenerMap | null = null

`Readonly`className

className: "LoadCache" = 'LoadCache'

enabled

enabled: boolean = true

`Readonly`isLoadCache

isLoadCache: true

`Static` `Readonly`FAILED

FAILED: 3 = LoadState.FAILED

`Static` `Readonly`LOADED

LOADED: 2 = LoadState.LOADED

`Static` `Readonly`PENDING

PENDING: 1 = LoadState.PENDING

Methods

clear

clear(): void
Returns void
- Defined in loader/LoadCache.ts:55

fire

fire(typeOrEvent?: string | DispatchEvent, detail?: unknown): boolean
Parameters
- OptionaltypeOrEvent: string | DispatchEvent
- Optionaldetail: unknown
Returns boolean
Inherited from EventDispatcher.fire
- Defined in core/EventDispatcher.ts:79

get

get(key: string): LoadCacheFile<Data> | null
Parameters
- key: string
Returns LoadCacheFile<Data> | null
- Defined in loader/LoadCache.ts:41

getLoaded

getLoaded(key: string): Data | null
Parameters
- key: string
Returns Data | null
- Defined in loader/LoadCache.ts:46

off

off(type?: string, listener?: EventListener<DispatchEvent>): this
Parameters
- Optionaltype: string
- Optionallistener: EventListener<DispatchEvent>
Returns this
Inherited from EventDispatcher.off
- Defined in core/EventDispatcher.ts:60

on

on(type: string, listener: EventListener, once?: boolean): this
Parameters
- type: string
- listener: EventListener
- once: boolean = false
Returns this
Inherited from EventDispatcher.on
- Defined in core/EventDispatcher.ts:48

remove

remove(key: string): void
Parameters
- key: string
Returns void
- Defined in loader/LoadCache.ts:51

update

update(key: string, state: LoadStateValue, data?: Data): void
Parameters
- key: string
- state: LoadStateValue
- Optionaldata: Data
Returns void
- Defined in loader/LoadCache.ts:33

wait

wait(file: LoadCacheFile<Data> | null): Promise<Data>
Parameters
- file: LoadCacheFile<Data> | null
Returns Promise<Data>
- Defined in loader/LoadCache.ts:59