Interface IEnr

interface IEnr {
    [toStringTag]: string;
    id: string;
    ip?: string;
    ip6?: string;
    multiaddrs?: Multiaddr[];
    nodeId?: string;
    peerId?: PeerId;
    peerInfo: undefined | PeerInfo;
    publicKey?: Uint8Array;
    seq: bigint;
    shardInfo?: ShardInfo;
    signature?: Uint8Array;
    size: number;
    tcp?: number;
    tcp6?: number;
    udp?: number;
    udp6?: number;
    waku2?: Waku2;
    [iterator](): IterableIterator<[string, Uint8Array]>;
    clear(): void;
    delete(key): boolean;
    entries(): IterableIterator<[string, Uint8Array]>;
    forEach(callbackfn, thisArg?): void;
    get(key): undefined | Uint8Array;
    getFullMultiaddrs(): Multiaddr[];
    has(key): boolean;
    keys(): IterableIterator<string>;
    set(key, value): this;
    values(): IterableIterator<Uint8Array>;
}

Hierarchy

Properties

[toStringTag] id ip? ip6? multiaddrs? nodeId? peerId? peerInfo publicKey? seq shardInfo? signature? size tcp? tcp6? udp? udp6? waku2?

Methods

[iterator] clear delete entries forEach get getFullMultiaddrs has keys set values

Properties

Readonly [toStringTag]

[toStringTag]: string

id

id: string

Optional ip

ip?: string

Optional ip6

ip6?: string

Optional multiaddrs

multiaddrs?: Multiaddr[]

Optional nodeId

nodeId?: string

Optional peerId

peerId?: PeerId

peerInfo

peerInfo: undefined | PeerInfo

Optional publicKey

publicKey?: Uint8Array

seq

seq: bigint

Optional shardInfo

shardInfo?: ShardInfo

Optional signature

signature?: Uint8Array

Readonly size

size: number

Returns

the number of elements in the Map.

Optional tcp

tcp?: number

Optional tcp6

tcp6?: number

Optional udp

udp?: number

Optional udp6

udp6?: number

Optional waku2

waku2?: Waku2

Methods

[iterator]

  • [iterator](): IterableIterator<[string, Uint8Array]>

  • Returns an iterable of entries in the map.

    Returns IterableIterator<[string, Uint8Array]>

clear

  • clear(): void

  • Returns void

delete

  • delete(key): boolean

  • Parameters

    • key: string

    Returns boolean

    true if an element in the Map existed and has been removed, or false if the element does not exist.

entries

  • entries(): IterableIterator<[string, Uint8Array]>

  • Returns an iterable of key, value pairs for every entry in the map.

    Returns IterableIterator<[string, Uint8Array]>

forEach

  • forEach(callbackfn, thisArg?): void

  • Executes a provided function once per each key/value pair in the Map, in insertion order.

    Parameters

    • callbackfn: ((value, key, map) => void)
        • (value, key, map): void

        • Parameters

          • value: Uint8Array
          • key: string
          • map: Map<string, Uint8Array>

          Returns void

    • Optional thisArg: any

    Returns void

get

  • get(key): undefined | Uint8Array

  • Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

    Parameters

    • key: string

    Returns undefined | Uint8Array

    Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

getFullMultiaddrs

  • getFullMultiaddrs(): Multiaddr[]

  • @deprecated: use IEnr.peerInfo instead.

    Returns Multiaddr[]

has

  • has(key): boolean

  • Parameters

    • key: string

    Returns boolean

    boolean indicating whether an element with the specified key exists or not.

keys

  • keys(): IterableIterator<string>

  • Returns an iterable of keys in the map

    Returns IterableIterator<string>

set

  • set(key, value): this

  • Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

    Parameters

    • key: string
    • value: Uint8Array

    Returns this

values

  • values(): IterableIterator<Uint8Array>

  • Returns an iterable of values in the map

    Returns IterableIterator<Uint8Array>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc