Class PeerList

We can't use PeerIds as list entries because list entries are compared using same-value-zero equality, so this is just a map that stringifies the PeerIds before storing them.

PeerIds cache stringified versions of themselves so this should be a cheap operation.

Example

import { peerList } from '@libp2p/peer-collections'

const list = peerList()
list.push(peerId)

Hierarchy

  • PeerList

Constructors

constructor

Properties

list

Accessors

length

Methods

[iterator] concat entries every filter find findIndex forEach includes indexOf pop push shift unshift

Constructors

constructor

Properties

Private Readonly list

list: string[]

Accessors

length

  • get length(): number

  • Returns number

Methods

[iterator]

concat

entries

  • Returns IterableIterator<[number, PeerId]>

every

  • Parameters

    Returns boolean

filter

find

findIndex

  • Parameters

    Returns number

forEach

includes

indexOf

pop

push

shift

unshift

Settings

Member Visibility

Theme