Skip to main content

VisorStore

Extends

Constructors

Constructor

new VisorStore(): VisorStore;

Returns

VisorStore

Overrides

AbstractStore.constructor

Properties

PropertyTypeInherited from
loggerLoggerAbstractStore.logger

Accessors

activeMetaData


initialized

Inherited from

AbstractStore.initialized


loadingDirectives


name

Get Signature

get name(): string;
Returns

string

Inherited from

AbstractStore.name

Methods

clearTimeout()

clearTimeout(): void;

Returns

void


getAverageStatus()

getAverageStatus(): LoadingDirectiveState;

Returns

LoadingDirectiveState


getControls()

getControls(): AbstractSetting<AbstractSettingOptions>[];

Returns

AbstractSetting<AbstractSettingOptions>[]

Inherited from

AbstractStore.getControls


getDirectives()

getDirectives(): VisorLoadingDirective[];

Returns

VisorLoadingDirective[]


getLatestMessage()

getLatestMessage(): string;

Returns

string


getLoadingPercentage()

getLoadingPercentage(): number;

Returns

number


getMetadata()

getMetadata(key): VisorMetadata;

Parameters

ParameterType
keystring

Returns

VisorMetadata


init()

init(): Promise<void>;

Returns

Promise<void>

Inherited from

AbstractStore.init


isLoading()

isLoading(): boolean;

Returns

boolean


loadingDirective()

loadingDirective(message): VisorLoadingDirective;

Parameters

ParameterType
messagestring

Returns

VisorLoadingDirective


popLoadingDirective()

popLoadingDirective(): void;

Returns

void


pushLoadingDirective()

pushLoadingDirective(directive): void;

Parameters

ParameterType
directiveVisorLoadingDirective

Returns

void


registerActiveMetadata()

registerActiveMetadata(metaData): void;

Parameters

ParameterType
metaDataVisorMetadata

Returns

void


setLogger()

setLogger(logger): void;

Parameters

ParameterType
loggerLogger

Returns

void

Inherited from

AbstractStore.setLogger


waitForReady()

waitForReady(): Promise<void>;

Returns

Promise<void>

Inherited from

AbstractStore.waitForReady


wrap()

Call Signature

wrap<T>(message, cb): Promise<T>;
Type Parameters
Type Parameter
T
Parameters
ParameterType
messagestring
cb(directive) => Promise<T>
Returns

Promise<T>

Call Signature

wrap<T, L>(directive, cb): Promise<T>;
Type Parameters
Type Parameter
T
L extends VisorLoadingDirective
Parameters
ParameterType
directiveL
cb(directive) => Promise<T>
Returns

Promise<T>