Class PeerDiscoveryStaticPeers

Pass a list of multiaddr that will be used to bootstrap a node.

Hierarchy

EventEmitter<PeerDiscoveryEvents>
Hierarchy
- PeerDiscoveryStaticPeers

Implements

PeerDiscovery

Index

Constructors

Properties

#private interval peers timer? DefaultInterval

Accessors

[symbol] [toStringTag]

Methods

_returnPeers _startTimer addEventListener dispatchEvent listenerCount removeEventListener start stop

Constructors

constructor

new PeerDiscoveryStaticPeers(peers: Multiaddr[] | string[], opts?: Options): PeerDiscoveryStaticPeers
Parameters
- peers: Multiaddr[] | string[]
  
  Multiaddrs of peers to connect to.
- Optional opts: Options
Returns PeerDiscoveryStaticPeers
Overrides EventEmitter<PeerDiscoveryEvents>.constructor
- Defined in src/lib/peer_discovery_static_list.ts:47

Properties

`Private` #private

#private: any

`Private` `Readonly` interval

interval: number

`Private` `Readonly` peers

peers: PeerInfo[]

`Private` `Optional` timer

timer?: Timer

`Static` DefaultInterval

DefaultInterval: number = 200

Accessors

[symbol]

get [symbol](): true
Returns true
Implementation of PeerDiscovery.__@symbol@3475
- Defined in src/lib/peer_discovery_static_list.ts:110

[toStringTag]

get [toStringTag](): string
Returns string
Implementation of PeerDiscovery.__@toStringTag@23
- Defined in src/lib/peer_discovery_static_list.ts:114

Methods

_returnPeers

_returnPeers(): void
Returns void
- Defined in src/lib/peer_discovery_static_list.ts:87

`Private` _startTimer

_startTimer(): void
Returns void
- Defined in src/lib/peer_discovery_static_list.ts:74

addEventListener

addEventListener<K>(type: K, listener: null | EventHandler<PeerDiscoveryEvents[K]>, options?: boolean | AddEventListenerOptions): void
Type Parameters
Type Parameters
- K extends "peer"
Parameters
- type: K
- listener: null | EventHandler<PeerDiscoveryEvents[K]>
- Optional options: boolean | AddEventListenerOptions
Returns void
Implementation of PeerDiscovery.addEventListener

Inherited from EventEmitter.addEventListener
- Defined in node_modules/@libp2p/interfaces/dist/src/events.d.ts:21

dispatchEvent

dispatchEvent(event: Event): boolean
Parameters
- event: Event
Returns boolean
Implementation of PeerDiscovery.dispatchEvent

Inherited from EventEmitter.dispatchEvent
- Defined in node_modules/@libp2p/interfaces/dist/src/events.d.ts:23

listenerCount

listenerCount(type: string): number
Parameters
- type: string
Returns number
Implementation of PeerDiscovery.listenerCount

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@libp2p/interfaces/dist/src/events.d.ts:20

removeEventListener

removeEventListener<K>(type: K, listener?: null | EventHandler<PeerDiscoveryEvents[K]>, options?: boolean | EventListenerOptions): void
Type Parameters
Type Parameters
- K extends "peer"
Parameters
- type: K
- Optional listener: null | EventHandler<PeerDiscoveryEvents[K]>
- Optional options: boolean | EventListenerOptions
Returns void
Implementation of PeerDiscovery.removeEventListener

Inherited from EventEmitter.removeEventListener
- Defined in node_modules/@libp2p/interfaces/dist/src/events.d.ts:22

start

start(): void
Start emitting static peers.

Returns void
- Defined in src/lib/peer_discovery_static_list.ts:70

stop

stop(): void
Stop emitting peers.

Returns void
- Defined in src/lib/peer_discovery_static_list.ts:102

Generated using TypeDoc