Skip to content

Welshman Docs / @welshman/app / Feeds

Class: Feeds ​

Defined in: plugins/feeds.ts:31

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 ​

Constructors ​

Constructor ​

new Feeds(app): Feeds

Defined in: plugins/feeds.ts:32

Parameters ​

app ​

IApp

Returns ​

Feeds

Overrides ​

DerivedPlugin.constructor

Properties ​

all ​

all: Projection<FeedReader[]>

Defined in: plugins/base.ts:167

Inherited from ​

DerivedPlugin.all


app ​

protected readonly app: IApp

Defined in: plugins/base.ts:175

Inherited from ​

DerivedPlugin.app


forceLoad ​

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

Defined in: plugins/base.ts:170

Parameters ​

key ​

string

args ​

...any[]

Returns ​

Promise<Maybe<FeedReader>>

Inherited from ​

DerivedPlugin.forceLoad


index ​

readonly index: ItemCollection<FeedReader>

Defined in: plugins/base.ts:176

Inherited from ​

DerivedPlugin.index


load ​

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

Defined in: plugins/base.ts:169

Parameters ​

key ​

string

args ​

...any[]

Returns ​

Promise<Maybe<FeedReader>>

Inherited from ​

DerivedPlugin.load


one ​

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

Defined in: plugins/base.ts:168

Parameters ​

key? ​

string

args ​

...any[]

Returns ​

Readable<Maybe<FeedReader>>

Inherited from ​

DerivedPlugin.one

Methods ​

create() ​

create(fields): Promise<Command>

Defined in: plugins/feeds.ts:54

Parameters ​

fields ​

FeedFields

Returns ​

Promise<Command>


fetch() ​

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

Defined in: plugins/feeds.ts:40

Parameters ​

address ​

string

relayHints? ​

string[] = []

Returns ​

Promise<TrustedEvent | undefined>

Overrides ​

DerivedPlugin.fetch


forAuthor() ​

forAuthor(pubkey): Projection<FeedReader[]>

Defined in: plugins/feeds.ts:48

Parameters ​

pubkey ​

string

Returns ​

Projection<FeedReader[]>


get() ​

get(key): FeedReader | undefined

Defined in: plugins/base.ts:190

Parameters ​

key ​

string

Returns ​

FeedReader | undefined

Inherited from ​

DerivedPlugin.get


getPubkeysForScope() ​

getPubkeysForScope(scope): string[]

Defined in: plugins/feeds.ts:76

Parameters ​

scope ​

Scope

Returns ​

string[]


getPubkeysForWOTRange() ​

getPubkeysForWOTRange(min, max): string[]

Defined in: plugins/feeds.ts:97

Parameters ​

min ​

number

max ​

number

Returns ​

string[]


loadForAuthor() ​

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

Defined in: plugins/feeds.ts:51

Parameters ​

pubkey ​

string

relayHints? ​

string[] = []

Returns ​

Promise<TrustedEvent[]>


makeFeedController() ​

makeFeedController(options): FeedController

Defined in: plugins/feeds.ts:115

Parameters ​

options ​

MakeFeedControllerOptions

Returns ​

FeedController


project() ​

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

Defined in: plugins/base.ts:192

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: plugins/feeds.ts:64

Parameters ​

address ​

string

fn ​

(writer) => void

Returns ​

Promise<Command>