Class PeerExchangeDiscovery

Hierarchy

EventEmitter<PeerDiscoveryEvents>
- PeerExchangeDiscovery

Implements

PeerDiscovery

Index

Constructors

Properties

#private components intervals isStarted options peerExchange

Accessors

[symbol] [toStringTag]

Methods

addEventListener dispatchEvent eventHandler listenerCount query removeEventListener start stop

Constructors

constructor

new PeerExchangeDiscovery(components: PeerExchangeComponents, options?: Options): PeerExchangeDiscovery
Parameters
- components: PeerExchangeComponents
- options: Options = {}
Returns PeerExchangeDiscovery
Overrides EventEmitter<PeerDiscoveryEvents>.constructor
- Defined in packages/peer-exchange/src/waku_peer_exchange_discovery.ts:66

Properties

`Private` #private

#private: any

`Private` `Readonly` components

components: PeerExchangeComponents

`Private` intervals

intervals: Map<PeerId, Timeout> = ...

`Private` isStarted

isStarted: boolean

`Private` `Readonly` options

options: Options

`Private` `Readonly` peerExchange

peerExchange: WakuPeerExchange

Accessors

[symbol]

get [symbol](): true
Returns true
Implementation of PeerDiscovery.__@symbol@4022
- Defined in packages/peer-exchange/src/waku_peer_exchange_discovery.ts:104

[toStringTag]

get [toStringTag](): string
Returns string
Implementation of PeerDiscovery.__@toStringTag@3068
- Defined in packages/peer-exchange/src/waku_peer_exchange_discovery.ts:108

Methods

addEventListener

addEventListener<K>(type: K, listener: null | EventHandler<PeerDiscoveryEvents[K]>, options?: boolean | AddEventListenerOptions): void
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

`Private` `Readonly` eventHandler

eventHandler(event: CustomEvent<PeerProtocolsChangeData>): Promise<void>
Parameters
- event: CustomEvent<PeerProtocolsChangeData>
Returns Promise<void>
- Defined in packages/peer-exchange/src/waku_peer_exchange_discovery.ts:51

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

`Private` query

query(peerId: PeerId): Promise<void>
Parameters
- peerId: PeerId
Returns Promise<void>
- Defined in packages/peer-exchange/src/waku_peer_exchange_discovery.ts:112

removeEventListener

removeEventListener<K>(type: K, listener?: null | EventHandler<PeerDiscoveryEvents[K]>, options?: boolean | EventListenerOptions): void
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 events

Returns void
- Defined in packages/peer-exchange/src/waku_peer_exchange_discovery.ts:77

stop

stop(): void
Remove event listener

Returns void
- Defined in packages/peer-exchange/src/waku_peer_exchange_discovery.ts:93

Generated using TypeDoc