Welshman

Appearance

Welshman Docs / @welshman/app / LoadableMapPlugin

Class: abstract LoadableMapPlugin<T> ​

Defined in: app/src/plugins/base.ts:168

A MapPlugin collection that knows how to lazily load items by key from the network. Subclasses implement fetch; load/forceLoad/one are derived from it (with per-key caching and backoff via makeLoadItem).

Extends ​

Extended by ​

Type Parameters ​

T ​

T

Constructors ​

Constructor ​

new LoadableMapPlugin<T>(app, options): LoadableMapPlugin<T>

Defined in: app/src/plugins/base.ts:174

Parameters ​

app ​

IApp

options ​

MakeLoadItemOptions = {}

Returns ​

LoadableMapPlugin<T>

Overrides ​

MapPlugin.constructor

Properties ​

all ​

all: Projection<T[]>

Defined in: app/src/plugins/base.ts:101

Inherited from ​

MapPlugin.all

app ​

protected readonly app: IApp

Defined in: app/src/plugins/base.ts:105

Inherited from ​

MapPlugin.app

forceLoad() ​

forceLoad: (key, ...args) => Promise<Maybe<T>>

Defined in: app/src/plugins/base.ts:170

Parameters ​

key ​

string

args ​

...any[]

Returns ​

Promise<Maybe<T>>

index ​

index: Projection<ItemsByKey<T>>

Defined in: app/src/plugins/base.ts:100

Inherited from ​

MapPlugin.index

load() ​

load: (key, ...args) => Promise<Maybe<T>>

Defined in: app/src/plugins/base.ts:169

Parameters ​

key ​

string

args ​

...any[]

Returns ​

Promise<Maybe<T>>

one() ​

one: (key?, ...args) => Readable<Maybe<T>>

Defined in: app/src/plugins/base.ts:102

Parameters ​

key? ​

string

args? ​

...any[]

Returns ​

Readable<Maybe<T>>

Inherited from ​

MapPlugin.one

store ​

protected store: Writable<Map<string, T>>

Defined in: app/src/plugins/base.ts:99

Inherited from ​

MapPlugin.store

subs ​

subs: (key, value) => void[] = []

Defined in: app/src/plugins/base.ts:103

Parameters ​

key ​

string

value ​

Maybe<T>

Returns ​

void

Inherited from ​

MapPlugin.subs

Methods ​

clear() ​

clear(): void

Defined in: app/src/plugins/base.ts:136

Returns ​

void

Inherited from ​

MapPlugin.clear

delete() ​

delete(key): void

Defined in: app/src/plugins/base.ts:126

Parameters ​

key ​

string

Returns ​

void

Inherited from ​

MapPlugin.delete

emitItem() ​

protected emitItem(key, value): void

Defined in: app/src/plugins/base.ts:156

Parameters ​

key ​

string

value ​

Maybe<T>

Returns ​

void

Inherited from ​

MapPlugin.emitItem

fetch() ​

abstract fetch(key, ...args): Promise<unknown>

Defined in: app/src/plugins/base.ts:172

Parameters ​

key ​

string

args ​

...any[]

Returns ​

Promise<unknown>

get() ​

get(key): undefined | T

Defined in: app/src/plugins/base.ts:111

Parameters ​

key ​

string

Returns ​

undefined | T

Inherited from ​

MapPlugin.get

onItem() ​

onItem(subscriber): Unsubscriber

Defined in: app/src/plugins/base.ts:146

Parameters ​

subscriber ​

(key, value) => void

Returns ​

Unsubscriber

Inherited from ​

MapPlugin.onItem

project() ​

project<U>(key, read): Projection<U>

Defined in: app/src/plugins/base.ts:113

Type Parameters ​

U ​

U

Parameters ​

key ​

string

read ​

(item) => U

Returns ​

Projection<U>

Inherited from ​

MapPlugin.project

set() ​

set(key, value): void

Defined in: app/src/plugins/base.ts:116

Parameters ​

key ​

string

value ​

T

Returns ​

void

Inherited from ​

MapPlugin.set