Welshman Docs / @welshman/app / RoomPinLists

Class: RoomPinLists

Defined in: app/src/plugins/roomPins.ts:16

NIP-29 kind-39005 room pin lists, keyed by ${url}'${h} like the rest of a room's state. The relay authors the list, so only its own signature counts; clients ask for a change with a kind-9010 op and the relay republishes the list.

Extends

• RelaySignedDerivedPlugin<RoomPinsReader>

Constructors

Constructor

new RoomPinLists(app): RoomPinLists

Defined in: app/src/plugins/roomPins.ts:17

Parameters

app

IApp

Returns

RoomPinLists

Overrides

RelaySignedDerivedPlugin.constructor

Properties

all

all: Projection<RoomPinsReader[]>

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

Inherited from

RelaySignedDerivedPlugin.all

---

app

protected readonly app: IApp

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

Inherited from

RelaySignedDerivedPlugin.app

---

forceLoad()

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

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

Parameters

key

string

args

...any[]

Returns

Promise<Maybe<RoomPinsReader>>

Inherited from

RelaySignedDerivedPlugin.forceLoad

---

index

index: Projection<ItemsByKey<RoomPinsReader>>

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

Inherited from

RelaySignedDerivedPlugin.index

---

load()

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

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

Parameters

key

string

args

...any[]

Returns

Promise<Maybe<RoomPinsReader>>

Inherited from

RelaySignedDerivedPlugin.load

---

one()

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

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

Parameters

key?

string

args?

...any[]

Returns

Readable<Maybe<RoomPinsReader>>

Inherited from

RelaySignedDerivedPlugin.one

Methods

fetch()

fetch(key, signal?): Promise<TrustedEvent[]>

Defined in: app/src/plugins/roomPins.ts:25

Parameters

key

string

signal?

AbortSignal

Returns

Promise<TrustedEvent[]>

Overrides

RelaySignedDerivedPlugin.fetch

---

forRoom()

forRoom(url, h): Readable<Maybe<RoomPinsReader>>

Defined in: app/src/plugins/roomPins.ts:33

Parameters

url

string

h

string

Returns

Readable<Maybe<RoomPinsReader>>

---

get()

get(key): undefined | RoomPinsReader

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

Parameters

key

string

Returns

undefined | RoomPinsReader

Inherited from

RelaySignedDerivedPlugin.get

---

loadForRoom()

loadForRoom(url, h, signal?): Promise<Maybe<RoomPinsReader>>

Defined in: app/src/plugins/roomPins.ts:35

Parameters

url

string

h

string

signal?

AbortSignal

Returns

Promise<Maybe<RoomPinsReader>>

---

pins()

pins(url, h): Projection<string[]>

Defined in: app/src/plugins/roomPins.ts:38

Parameters

url

string

h

string

Returns

Projection<string[]>

---

project()

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

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

Type Parameters

U

U

Parameters

key

string

read

(item) => U

Returns

Projection<U>

Inherited from

RelaySignedDerivedPlugin.project

---

setPins()

setPins(url, h, idsOrAddresses): Promise<Command>

Defined in: app/src/plugins/roomPins.ts:41

Parameters

url

string

h

string

idsOrAddresses

string[]

Returns

Promise<Command>