Welshman Docs / @welshman/util / Address

Class: Address

Defined in: Address.ts:10

Constructors

Constructor

new Address(kind, pubkey, identifier, relays): Address

Defined in: Address.ts:11

Parameters

kind

number

pubkey

string

identifier

string

relays

string[] = []

Returns

Address

Properties

identifier

readonly identifier: string

Defined in: Address.ts:14

---

kind

readonly kind: number

Defined in: Address.ts:12

---

pubkey

readonly pubkey: string

Defined in: Address.ts:13

---

relays

readonly relays: string[] = []

Defined in: Address.ts:15

Methods

toNaddr()

toNaddr(): `naddr1${string}`

Defined in: Address.ts:54

Returns

`naddr1${string}`

---

toString()

toString(): string

Defined in: Address.ts:52

Returns

string

---

from()

static from(address, relays): Address

Defined in: Address.ts:22

Parameters

address

string

relays

string[] = []

Returns

Address

---

fromEvent()

static fromEvent(event, relays): Address

Defined in: Address.ts:46

Parameters

event

AddressableEvent

relays

string[] = []

Returns

Address

---

fromNaddr()

static fromNaddr(naddr): Address

Defined in: Address.ts:28

Parameters

naddr

string

Returns

Address

---

isAddress()

static isAddress(address): boolean

Defined in: Address.ts:18

Parameters

address

string

Returns

boolean