Interface IResourceMonitor

Represents a resource monitor. Extends IResourceContainer.

interface IResourceMonitor {
    getResource<TResource>(Resource): TResource;
    resolveAll(): void;
    tryAdd<TResource>(Resource, resolver?): boolean;
}

Hierarchy (view full)

IResourceContainer
- IResourceMonitor

Implemented by

ResourceMonitor

Index

Methods

getResource resolveAll tryAdd

Methods

getResource

getResource<TResource>(Resource): TResource
Gets the instance of the specified resource.
Type Parameters
- TResource extends IAsyncDisposable
  The type of the resource to retrieve.
Parameters
- Resource: Constructor<TResource>
  The constructor of the resource to retrieve.
Returns TResource
The instance of the resource.

Throws
if the resource is not found.
Inherited from IResourceContainer.getResource
- Defined in abstractions/IResourceContainer.ts:15

resolveAll

resolveAll(): void
Resolves all registered resources.

Returns void
- Defined in abstractions/IResourceMonitor.ts:29

tryAdd

tryAdd<TResource>(Resource, resolver?): boolean
Tries to add a resource to the monitor.
Type Parameters
- TResource extends IAsyncDisposable
  The type of the resource to add.
Parameters
- Resource: Constructor<TResource>
  The constructor of the resource to add.
- Optional resolver: Resolver<TResource>
  The resolver function for the resource (optional).
Returns boolean
True if the resource was successfully added, false otherwise.
- Defined in abstractions/IResourceMonitor.ts:21

Generated using TypeDoc