Interface LazyModule<M>

A module that is loaded on first use.

interface LazyModule<M> {
    key: string;
    prefetch: boolean;
    tier: LazyModuleTier;
    load(): Promise<M>;
    peek(): M | undefined;
}

Type Parameters

M

Index

Properties

key prefetch tier

Methods

Properties

`Readonly`key

key: string

Unique key, for example 'studio:sortDialog'.

`Readonly`prefetch

prefetch: boolean

Whether the module may be loaded ahead of use.

`Readonly`tier

tier: LazyModuleTier

How likely the module is to be needed.

Methods

load

load(): Promise<M>

Loads the module, or returns it if it is already loaded.

Returns Promise<M>

Remarks
Concurrent calls share one attempt. A failed attempt is not remembered, so calling again tries again. Rejects with a LazyLoadError.

peek

peek(): M | undefined

The module if it has loaded, otherwise undefined.

Returns M | undefined