Class PeerStore

fires

PeerStore#peer Emitted when a new peer is added.

fires

PeerStore#change:protocols Emitted when a known peer supports a different set of protocols.

fires

PeerStore#change:multiaddrs Emitted when a known peer has a different set of multiaddrs.

fires

PeerStore#change:pubkey Emitted emitted when a peer's public key is known.

fires

PeerStore#change:metadata Emitted when the known metadata of a peer change.

Hierarchy

Index

References

Constructors

Properties

Accessors

Methods

References

Address

Re-exports Address

Events

Re-exports Events

Constructors

constructor

  • Responsible for managing known peers, as well as their addresses, protocols and metadata.

    Parameters

    Returns PeerStore

Properties

_peerId

_peerId: PeerId

addressBook

addressBook: AddressBook

AddressBook containing a map of peerIdStr to Address.

keyBook

keyBook: KeyBook

KeyBook containing a map of peerIdStr to their PeerId with public keys.

metadataBook

metadataBook: MetadataBook

MetadataBook containing a map of peerIdStr to their metadata Map.

protoBook

protoBook: ProtoBook

ProtoBook containing a map of peerIdStr to supported protocols.

Accessors

peers

  • get peers(): Map<string, { addresses: Address[]; id: PeerId; metadata: Map<string, Uint8Array> | undefined; protocols: string[] }>

  • Get all the stored information of every peer known.

    Returns Map<string, { addresses: Address[]; id: PeerId; metadata: Map<string, Uint8Array> | undefined; protocols: string[] }>

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): any

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns any

delete

  • delete(peerId: PeerId): boolean

  • Delete the information of the given peer in every book.

    Parameters

    Returns boolean

    true if found and removed

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

get

  • get(peerId: PeerId): { addresses: Address[]; id: PeerId; metadata: Map<string, Uint8Array> | undefined; protocols: string[] } | undefined

  • Get the stored information of a given peer.

    Parameters

    Returns { addresses: Address[]; id: PeerId; metadata: Map<string, Uint8Array> | undefined; protocols: string[] } | undefined

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(event: string | symbol): number

listeners

  • listeners(event: string | symbol): Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): any

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns any

on

  • on(event: string | symbol, listener: (...args: any[]) => void): any

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns any

once

  • once(event: string | symbol, listener: (...args: any[]) => void): any

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns any

rawListeners

  • rawListeners(event: string | symbol): Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): any

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): any

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns any

setMaxListeners

  • setMaxListeners(n: number): any

start

  • start(): void

  • Start the PeerStore.

    Returns void

stop

  • stop(): void

  • Stop the PeerStore.

    Returns void