Welshman Docs / @welshman/app / MapPlugin
Class: MapPlugin<T>
Defined in: app/src/plugins/base.ts:98
Base class for a reactive, keyed collection of "local" (non-event) data — things like relay stats or NIP-11 profiles that aren't backed by the repository. The collection owns its own map.
index (map) and all (values) are Projections — subscribe via .$, snapshot via .get(). Per-key access is one(key), a plain on-demand store (snapshot with svelte's get(...), or read get(key) directly).
Extended by
Type Parameters
T
T
Constructors
Constructor
new MapPlugin<
T>(app):MapPlugin<T>
Defined in: app/src/plugins/base.ts:105
Parameters
app
Returns
MapPlugin<T>
Properties
all
all:
Projection<T[]>
Defined in: app/src/plugins/base.ts:101
app
protectedreadonlyapp:IApp
Defined in: app/src/plugins/base.ts:105
index
index:
Projection<ItemsByKey<T>>
Defined in: app/src/plugins/base.ts:100
one()
one: (
key?, ...args) =>Readable<Maybe<T>>
Defined in: app/src/plugins/base.ts:102
Parameters
key?
string
args?
...any[]
Returns
Readable<Maybe<T>>
store
protectedstore:Writable<Map<string,T>>
Defined in: app/src/plugins/base.ts:99
subs
subs: (
key,value) =>void[] =[]
Defined in: app/src/plugins/base.ts:103
Parameters
key
string
value
Maybe<T>
Returns
void
Methods
clear()
clear():
void
Defined in: app/src/plugins/base.ts:136
Returns
void
delete()
delete(
key):void
Defined in: app/src/plugins/base.ts:126
Parameters
key
string
Returns
void
emitItem()
protectedemitItem(key,value):void
Defined in: app/src/plugins/base.ts:156
Parameters
key
string
value
Maybe<T>
Returns
void
get()
get(
key):undefined|T
Defined in: app/src/plugins/base.ts:111
Parameters
key
string
Returns
undefined | T
onItem()
onItem(
subscriber):Unsubscriber
Defined in: app/src/plugins/base.ts:146
Parameters
subscriber
(key, value) => void
Returns
Unsubscriber
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>
set()
set(
key,value):void
Defined in: app/src/plugins/base.ts:116
Parameters
key
string
value
T
Returns
void