Class RelayMonitor

Cast a kind 10166 event to a RelayMonitor

Hierarchy (View Summary)

EventCast<RelayMonitorAnnouncementEvent>
- RelayMonitor

Index

Constructors

Properties

Accessors

author checks createdAt frequency geohash id seen timeouts uid

Methods

$$ref relayStatus

Constructors

constructor

new RelayMonitor(event: NostrEvent, store: CastRefEventStore): RelayMonitor
Parameters
- event: NostrEvent
- store: CastRefEventStore
Returns RelayMonitor
Overrides EventCast.constructor
- Defined in common/src/casts/relay-monitor.ts:19

Properties

`Readonly`event

event: RelayMonitorAnnouncementEvent

`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

checks

get checks(): string[]
Gets all checks conducted by this monitor

Returns string[]
- Defined in common/src/casts/relay-monitor.ts:35

createdAt

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

frequency

get frequency(): number | undefined
Gets the frequency at which this monitor publishes events (in seconds)

Returns number | undefined
- Defined in common/src/casts/relay-monitor.ts:25

geohash

get geohash(): string | undefined
Gets the geohash from this monitor announcement (NIP-52 geohash)

Returns string | undefined
- Defined in common/src/casts/relay-monitor.ts:40

id

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

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

timeouts

get timeouts(): { test?: string; timeout: number }[]
Gets all timeout values from this monitor announcement

Returns { test?: string; timeout: number }[]
- Defined in common/src/casts/relay-monitor.ts:30

uid

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

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

relayStatus

relayStatus(relay: string): ChainableObservable<RelayDiscovery | undefined>
Get the status of a relay from this monitor
Parameters
- relay: string
Returns ChainableObservable<RelayDiscovery | undefined>
- Defined in common/src/casts/relay-monitor.ts:45