Welshman Docs / @welshman/util / EventRef

Class: EventRef

Defined in: packages/util/src/EventRef.ts:22

Implements

• IEventRef

Constructors

Constructor

new EventRef(__namedParameters): EventRef

Defined in: packages/util/src/EventRef.ts:29

Parameters

__namedParameters

IEventRef

Returns

EventRef

Properties

id?

readonly optional id?: string

Defined in: packages/util/src/EventRef.ts:23

Implementation of

IEventRef.id

---

identifier?

readonly optional identifier?: string

Defined in: packages/util/src/EventRef.ts:26

Implementation of

IEventRef.identifier

---

kind?

readonly optional kind?: number

Defined in: packages/util/src/EventRef.ts:25

Implementation of

IEventRef.kind

---

pubkey?

readonly optional pubkey?: string

Defined in: packages/util/src/EventRef.ts:24

Implementation of

IEventRef.pubkey

---

relays

readonly relays: string[]

Defined in: packages/util/src/EventRef.ts:27

Implementation of

IEventRef.relays

Methods

getAddress()

getAddress(): Address | undefined

Defined in: packages/util/src/EventRef.ts:91

Returns

Address | undefined

---

getAddressOrId()

getAddressOrId(): string | undefined

Defined in: packages/util/src/EventRef.ts:100

Returns

string | undefined

---

getFilters()

getFilters(): Filter[]

Defined in: packages/util/src/EventRef.ts:105

Returns

Filter[]

---

getIdAndAddress()

getIdAndAddress(): string[]

Defined in: packages/util/src/EventRef.ts:103

Returns

string[]

---

getIdOrAddress()

getIdOrAddress(): string | undefined

Defined in: packages/util/src/EventRef.ts:97

Returns

string | undefined

---

getRelaySelections()

getRelaySelections(): RelaySelection[]

Defined in: packages/util/src/EventRef.ts:112

Returns

RelaySelection[]

---

toNip19()

toNip19(): `nevent1${string}` | `naddr1${string}` | undefined

Defined in: packages/util/src/EventRef.ts:119

Returns

`nevent1${string}` | `naddr1${string}` | undefined

---

fromAddress()

static fromAddress(__namedParameters): EventRef

Defined in: packages/util/src/EventRef.ts:57

Parameters

__namedParameters

Address

Returns

EventRef

---

fromEvent()

static fromEvent(event, relays?): EventRef

Defined in: packages/util/src/EventRef.ts:38

Parameters

event

TrustedEvent

relays?

string[] = []

Returns

EventRef

---

fromNip19()

static fromNip19(entity): EventRef | undefined

Defined in: packages/util/src/EventRef.ts:79

Parameters

entity

string

Returns

EventRef | undefined

---

fromPointer()

static fromPointer(pointer): EventRef

Defined in: packages/util/src/EventRef.ts:46

Parameters

pointer

AddressPointer | EventPointer

Returns

EventRef

---

fromString()

static fromString(idOrAddress, relays?): EventRef

Defined in: packages/util/src/EventRef.ts:61

Parameters

idOrAddress

string

relays?

string[] = []

Returns

EventRef

---

merge()

static merge(a, b): EventRef

Defined in: packages/util/src/EventRef.ts:68

Parameters

a

IEventRef

b

IEventRef

Returns

EventRef