Welshman Docs / @welshman/app / Feeds

Class: Feeds

Defined in: app/src/plugins/feeds.ts:30

NIP-51 kind-31890 saved feeds, keyed by address (many feeds per author). Also builds FeedControllers wired to this app. Scope/WOT pubkey resolution is delegated to Wot, and feeds fetch through THIS app's net context (pool + repository) rather than the global one.

Extends

• DerivedPlugin<FeedReader>

Constructors

Constructor

new Feeds(app): Feeds

Defined in: app/src/plugins/feeds.ts:31

Parameters

app

IApp

Returns

Feeds

Overrides

DerivedPlugin.constructor

Properties

all

all: Projection<FeedReader[]>

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<FeedReader>>

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

Parameters

key

string

args

...any[]

Returns

Promise<Maybe<FeedReader>>

Inherited from

DerivedPlugin.forceLoad

---

index

index: Projection<ItemsByKey<FeedReader>>

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

Inherited from

DerivedPlugin.index

---

load()

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

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

Parameters

key

string

args

...any[]

Returns

Promise<Maybe<FeedReader>>

Inherited from

DerivedPlugin.load

---

one()

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

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

Parameters

key?

string

args?

...any[]

Returns

Readable<Maybe<FeedReader>>

Inherited from

DerivedPlugin.one

Methods

create()

create(fields): Promise<Command>

Defined in: app/src/plugins/feeds.ts:53

Parameters

fields

FeedFields

Returns

Promise<Command>

---

fetch()

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

Defined in: app/src/plugins/feeds.ts:39

Parameters

address

string

relayHints

string[] = []

Returns

Promise<undefined | TrustedEvent>

Overrides

DerivedPlugin.fetch

---

forAuthor()

forAuthor(pubkey): Projection<FeedReader[]>

Defined in: app/src/plugins/feeds.ts:47

Parameters

pubkey

string

Returns

Projection<FeedReader[]>

---

get()

get(key): undefined | FeedReader

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

Parameters

key

string

Returns

undefined | FeedReader

Inherited from

DerivedPlugin.get

---

getPubkeysForScope()

getPubkeysForScope(scope): string[]

Defined in: app/src/plugins/feeds.ts:75

Parameters

scope

Scope

Returns

string[]

---

getPubkeysForWOTRange()

getPubkeysForWOTRange(min, max): string[]

Defined in: app/src/plugins/feeds.ts:96

Parameters

min

number

max

number

Returns

string[]

---

loadForAuthor()

loadForAuthor(pubkey, relayHints): Promise<TrustedEvent[]>

Defined in: app/src/plugins/feeds.ts:50

Parameters

pubkey

string

relayHints

string[] = []

Returns

Promise<TrustedEvent[]>

---

makeFeedController()

makeFeedController(options): FeedController

Defined in: app/src/plugins/feeds.ts:114

Parameters

options

MakeFeedControllerOptions

Returns

FeedController

---

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

---

update()

update(address, fn): Promise<Command>

Defined in: app/src/plugins/feeds.ts:63

Parameters

address

string

fn

(writer) => void

Returns

Promise<Command>