Welshman Docs / @welshman/app / Notify

Class: Notify

Defined in: plugins/notify.ts:23

The latest NOTIFY message per relay url. A relay sends one to tell the authenticated user something about their account — a failed payment, an expiring membership — and replaces it by sending another, so only the most recent one per relay is kept. A pure store; the socket wiring that fills it lives in appPolicyNotify.

The store is in memory. A relay may resend its latest message after every AUTH, so anything that needs a message to stay dismissed persists that itself.

Extends

• MapPlugin<NotifyItem>

Constructors

Constructor

new Notify(app): Notify

Defined in: plugins/base.ts:81

Parameters

app

IApp

Returns

Notify

Inherited from

MapPlugin.constructor

Properties

all

all: Projection<NotifyItem[]>

Defined in: plugins/base.ts:77

Inherited from

MapPlugin.all

---

app

protected readonly app: IApp

Defined in: plugins/base.ts:81

Inherited from

MapPlugin.app

---

index

index: Projection<ItemsByKey<NotifyItem>>

Defined in: plugins/base.ts:76

Inherited from

MapPlugin.index

---

one

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

Defined in: plugins/base.ts:78

Parameters

key?

string

args

...any[]

Returns

Readable<Maybe<NotifyItem>>

Inherited from

MapPlugin.one

---

store

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

Defined in: plugins/base.ts:75

Inherited from

MapPlugin.store

---

subs

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

Defined in: plugins/base.ts:79

Parameters

key

string

value

Maybe<NotifyItem>

Returns

void

Inherited from

MapPlugin.subs

Methods

clear()

clear(): void

Defined in: plugins/base.ts:112

Returns

void

Inherited from

MapPlugin.clear

---

delete()

delete(key): void

Defined in: plugins/base.ts:102

Parameters

key

string

Returns

void

Inherited from

MapPlugin.delete

---

emitItem()

protected emitItem(key, value): void

Defined in: plugins/base.ts:132

Parameters

key

string

value

Maybe<NotifyItem>

Returns

void

Inherited from

MapPlugin.emitItem

---

get()

get(key): NotifyItem | undefined

Defined in: plugins/base.ts:87

Parameters

key

string

Returns

NotifyItem | undefined

Inherited from

MapPlugin.get

---

monitorSocket()

monitorSocket(socket): () => void

Defined in: plugins/notify.ts:30

Parameters

socket

Socket

Returns

() => void

---

onItem()

onItem(subscriber): Unsubscriber

Defined in: plugins/base.ts:122

Parameters

subscriber

(key, value) => void

Returns

Unsubscriber

Inherited from

MapPlugin.onItem

---

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>

Inherited from

MapPlugin.project

---

set()

set(key, value): void

Defined in: plugins/base.ts:92

Parameters

key

string

value

NotifyItem

Returns

void

Inherited from

MapPlugin.set