Welshman Docs / @welshman/app / FollowLists

Class: FollowLists

Defined in: app/src/plugins/followLists.ts:13

Kind-3 follow lists, keyed by pubkey. Loaded via the outbox model (the author's write relays), so it depends on the relay-list collection.

Extends

• DerivedPlugin<FollowListReader>

Constructors

Constructor

new FollowLists(app): FollowLists

Defined in: app/src/plugins/followLists.ts:14

Parameters

app

IApp

Returns

FollowLists

Overrides

DerivedPlugin.constructor

Properties

all

all: Projection<FollowListReader[]>

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

Inherited from

DerivedPlugin.all

---

app

protected readonly app: IApp

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

Inherited from

DerivedPlugin.app

---

forceLoad()

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

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

Parameters

key

string

args

...any[]

Returns

Promise<Maybe<FollowListReader>>

Inherited from

DerivedPlugin.forceLoad

---

index

index: Projection<ItemsByKey<FollowListReader>>

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

Inherited from

DerivedPlugin.index

---

load()

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

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

Parameters

key

string

args

...any[]

Returns

Promise<Maybe<FollowListReader>>

Inherited from

DerivedPlugin.load

---

one()

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

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

Parameters

key?

string

args?

...any[]

Returns

Readable<Maybe<FollowListReader>>

Inherited from

DerivedPlugin.one

Methods

fetch()

fetch(pubkey, relayHints): Promise<undefined | TrustedEvent>

Defined in: app/src/plugins/followLists.ts:22

Parameters

pubkey

string

relayHints

string[] = []

Returns

Promise<undefined | TrustedEvent>

Overrides

DerivedPlugin.fetch

---

follow()

follow(tag): Promise<Command>

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

Parameters

tag

string[]

Returns

Promise<Command>

---

get()

get(key): undefined | FollowListReader

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

Parameters

key

string

Returns

undefined | FollowListReader

Inherited from

DerivedPlugin.get

---

project()

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

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

Type Parameters

U

U

Parameters

key

string

read

(item) => U

Returns

Projection<U>

Inherited from

DerivedPlugin.project

---

unfollow()

unfollow(value): Promise<Command>

Defined in: app/src/plugins/followLists.ts:37

Parameters

value

string

Returns

Promise<Command>

---

update()

update(fn): Promise<Command>

Defined in: app/src/plugins/followLists.ts:26

Parameters

fn

(writer) => void

Returns

Promise<Command>