@web-engine-dev/resources / Resources
Interface: Resources
The Resources container manages global resources and singletons
Methods
clear()
clear():
void
Clear all resources If autoDispose is enabled, will call dispose() on Disposable resources
Returns
void
get()
get<
T>(descriptor):T
Get a resource (read-only)
Type Parameters
T
T
Parameters
descriptor
Resource type descriptor
Returns
T
The resource value
Throws
If the resource doesn't exist
getChanged()
getChanged():
ResourceType[]
Get all changed resources (requires enableChangeTracking)
Returns
Array of resource types that have been mutated via getMut
getMut()
getMut<
T>(descriptor):T
Get a resource (mutable)
Type Parameters
T
T
Parameters
descriptor
Resource type descriptor
Returns
T
The resource value
Throws
If the resource doesn't exist
getOrInsert()
getOrInsert<
T>(descriptor,defaultValue):T
Get or insert a resource
Type Parameters
T
T
Parameters
descriptor
Resource type descriptor
defaultValue
T
Default value if resource doesn't exist
Returns
T
The resource value
getOrInsertWith()
getOrInsertWith<
T>(descriptor,initializer):T
Get or insert a resource with lazy initialization
Type Parameters
T
T
Parameters
descriptor
Resource type descriptor
initializer
Function to create the resource if it doesn't exist
Returns
T
The resource value
has()
has<
T>(descriptor):boolean
Check if a resource exists
Type Parameters
T
T
Parameters
descriptor
Resource type descriptor
Returns
boolean
insert()
insert<
T>(descriptor,value):void
Insert a resource into the container
Type Parameters
T
T
Parameters
descriptor
Resource type descriptor
value
T
The resource value
Returns
void
insertLazy()
insertLazy<
T>(descriptor,initializer):void
Insert a resource with lazy initialization
Type Parameters
T
T
Parameters
descriptor
Resource type descriptor
initializer
Function to create the resource on first access
Returns
void
query()
query<
T>(descriptor):ResourceQuery<T>
Create a query for a resource
Type Parameters
T
T
Parameters
descriptor
Resource type descriptor
Returns
A ResourceQuery for the resource
remove()
remove<
T>(descriptor):T|undefined
Remove a resource
Type Parameters
T
T
Parameters
descriptor
Resource type descriptor
Returns
T | undefined
The removed resource value or undefined
resetChanged()
resetChanged():
void
Reset the changed flag for all resources (requires enableChangeTracking)
Returns
void
size()
size():
number
Get the number of resources
Returns
number
tryGet()
tryGet<
T>(descriptor):T|undefined
Try to get a resource (returns undefined if not found)
Type Parameters
T
T
Parameters
descriptor
Resource type descriptor
Returns
T | undefined
The resource value or undefined
tryGetMut()
tryGetMut<
T>(descriptor):T|undefined
Try to get a resource (mutable, returns undefined if not found)
Type Parameters
T
T
Parameters
descriptor
Resource type descriptor
Returns
T | undefined
The resource value or undefined
types()
types():
ResourceType[]
Get all resource types