Welshman Docs / @welshman/app / MapPlugin

Class: MapPlugin<T>

Defined in: plugins/base.ts:74

A keyed collection of data not backed by the repository, such as relay stats or NIP-11 info.

Extended by

• LoadableMapPlugin
• RelayStats
• Notify
• Plaintext

Type Parameters

T

T

Constructors

Constructor

new MapPlugin<T>(app): MapPlugin<T>

Defined in: plugins/base.ts:81

Parameters

app

IApp

Returns

MapPlugin<T>

Properties

all

all: Projection<T[]>

Defined in: plugins/base.ts:77

---

app

protected readonly app: IApp

Defined in: plugins/base.ts:81

---

index

index: Projection<ItemsByKey<T>>

Defined in: plugins/base.ts:76

---

one

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

Defined in: plugins/base.ts:78

Parameters

key?

string

args

...any[]

Returns

Readable<Maybe<T>>

---

store

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

Defined in: plugins/base.ts:75

---

subs

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

Defined in: plugins/base.ts:79

Parameters

key

string

value

Maybe<T>

Returns

void

Methods

clear()

clear(): void

Defined in: plugins/base.ts:112

Returns

void

---

delete()

delete(key): void

Defined in: plugins/base.ts:102

Parameters

key

string

Returns

void

---

emitItem()

protected emitItem(key, value): void

Defined in: plugins/base.ts:132

Parameters

key

string

value

Maybe<T>

Returns

void

---

get()

get(key): T | undefined

Defined in: plugins/base.ts:87

Parameters

key

string

Returns

T | undefined

---

onItem()

onItem(subscriber): Unsubscriber

Defined in: plugins/base.ts:122

Parameters

subscriber

(key, value) => void

Returns

Unsubscriber

---

project()

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

Defined in: plugins/base.ts:89

Type Parameters

U

U

Parameters

key

string

read

(item) => U

Returns

Projection<U>

---

set()

set(key, value): void

Defined in: plugins/base.ts:92

Parameters

key

string

value

T

Returns

void