Class Mutes

Class for mute lists (kind 10000)

Hierarchy (View Summary)

EventCast<MuteListEvent>
- Mutes

Implements

MutedThings

Index

Constructors

Properties

Accessors

author createdAt hasHidden hashtags hidden hidden$ id mutes pubkeys seen threads uid unlocked words

Methods

Constructors

constructor

new Mutes(event: NostrEvent, store: CastRefEventStore): Mutes
Parameters
- event: NostrEvent
- store: CastRefEventStore
Returns Mutes
Overrides EventCast.constructor
- Defined in common/src/casts/mutes.ts:18

Properties

`Readonly`event

event: MuteListEvent

`Readonly`store

store: CastRefEventStore

Accessors

author

get author(): User
Get the User that authored this event

Returns User
Inherited from EventCast.author
- Defined in common/src/casts/cast.ts:59

createdAt

get createdAt(): Date
Returns Date
Inherited from EventCast.createdAt
- Defined in common/src/casts/cast.ts:54

hasHidden

get hasHidden(): boolean
Whether the mute list has hidden mutes

Returns boolean
- Defined in common/src/casts/mutes.ts:58

hashtags

get hashtags(): Set<string>
Returns Set<string>
Implementation of MutedThings.hashtags
- Defined in common/src/casts/mutes.ts:27

hidden

get hidden(): MutedThings | undefined
Get the unlocked hidden mutes

Returns MutedThings | undefined
- Defined in common/src/casts/mutes.ts:41

hidden$

get hidden$(): ChainableObservable<MutedThings>
An observable that updates when hidden mutes are unlocked

Returns ChainableObservable<MutedThings>
- Defined in common/src/casts/mutes.ts:45

id

get id(): string
Returns string
Inherited from EventCast.id
- Defined in common/src/casts/cast.ts:47

mutes

get mutes(): MutedThings
Returns MutedThings
- Defined in common/src/casts/mutes.ts:23

pubkeys

get pubkeys(): Set<string>
Returns Set<string>
Implementation of MutedThings.pubkeys
- Defined in common/src/casts/mutes.ts:33

seen

get seen(): Set<string> | undefined
Return the set of relays this event was seen on

Returns Set<string> | undefined
Inherited from EventCast.seen
- Defined in common/src/casts/cast.ts:64

threads

get threads(): Set<string>
Returns Set<string>
Implementation of MutedThings.threads
- Defined in common/src/casts/mutes.ts:36

uid

get uid(): string
Returns string
Inherited from EventCast.uid
- Defined in common/src/casts/cast.ts:50

unlocked

get unlocked(): boolean
Whether the mute list is unlocked

Returns boolean
- Defined in common/src/casts/mutes.ts:62

words

get words(): Set<string>
Returns Set<string>
Implementation of MutedThings.words
- Defined in common/src/casts/mutes.ts:30

Methods

`Protected`$$ref

$$ref<Return extends unknown>(
key: string,
builder: (store: CastRefEventStore) => Observable<Return>,
): ChainableObservable<Return>
Internal method for creating a reference
Type Parameters
- Return extends unknown
Parameters
- key: string
- builder: (store: CastRefEventStore) => Observable<Return>
Returns ChainableObservable<Return>
Inherited from EventCast.$$ref
- Defined in common/src/casts/cast.ts:78

unlock

unlock(signer: HiddenContentSigner): Promise<MutedThings>
Unlocks the hidden mutes on the mute list
Parameters
- signer: HiddenContentSigner
Returns Promise<MutedThings>
- Defined in common/src/casts/mutes.ts:66