Welshman

Appearance

Welshman Docs / @welshman/app / MuteLists

Class: MuteLists ​

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

Kind-10000 mute lists, keyed by pubkey.

Extends ​

Constructors ​

Constructor ​

new MuteLists(app): MuteLists

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

Parameters ​

app ​

IApp

Returns ​

MuteLists

Overrides ​

DerivedPlugin.constructor

Properties ​

all ​

all: Projection<MuteListReader[]>

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

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

Parameters ​

key ​

string

args ​

...any[]

Returns ​

Promise<Maybe<MuteListReader>>

Inherited from ​

DerivedPlugin.forceLoad

index ​

index: Projection<ItemsByKey<MuteListReader>>

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

Inherited from ​

DerivedPlugin.index

load() ​

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

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

Parameters ​

key ​

string

args ​

...any[]

Returns ​

Promise<Maybe<MuteListReader>>

Inherited from ​

DerivedPlugin.load

one() ​

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

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

Parameters ​

key? ​

string

args? ​

...any[]

Returns ​

Readable<Maybe<MuteListReader>>

Inherited from ​

DerivedPlugin.one

Methods ​

fetch() ​

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

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

Parameters ​

pubkey ​

string

relayHints ​

string[] = []

Returns ​

Promise<undefined | TrustedEvent>

Overrides ​

DerivedPlugin.fetch

get() ​

get(key): undefined | MuteListReader

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

Parameters ​

key ​

string

Returns ​

undefined | MuteListReader

Inherited from ​

DerivedPlugin.get

mutePrivately() ​

mutePrivately(tag): Promise<Command>

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

Parameters ​

tag ​

string[]

Returns ​

Promise<Command>

mutePublicly() ​

mutePublicly(tag): Promise<Command>

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

Parameters ​

tag ​

string[]

Returns ​

Promise<Command>

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

setMutes() ​

setMutes(updates): Promise<Command>

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

Parameters ​

updates ​
privateTags? ​

string[][]

publicTags? ​

string[][]

Returns ​

Promise<Command>

unmute() ​

unmute(value): Promise<Command>

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

Parameters ​

value ​

string

Returns ​

Promise<Command>

update() ​

update(fn): Promise<Command>

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

Parameters ​

fn ​

(writer) => void

Returns ​

Promise<Command>