Class LocalPeerCacheDiscovery

Hierarchy

TypedEventEmitter<PeerDiscoveryEvents>
- LocalPeerCacheDiscovery

Implements

PeerDiscovery
Startable

Index

Constructors

Properties

#private components isStarted options? peers

Accessors

Methods

addEventListener dispatchEvent getPeersFromLocalStorage handleNewPeers listenerCount removeEventListener safeDispatchEvent savePeersToLocalStorage start stop

Constructors

constructor

new LocalPeerCacheDiscovery(components, options?): LocalPeerCacheDiscovery
Parameters
- components: Components
- Optional options: LocalPeerCacheDiscoveryOptions
Returns LocalPeerCacheDiscovery
Overrides TypedEventEmitter<PeerDiscoveryEvents>.constructor
- Defined in packages/local-peer-cache-discovery/src/index.ts:38

Properties

`Private` #private

#private: any

`Private` `Readonly` components

components: Components

`Private` isStarted

isStarted: boolean

`Private` `Optional` `Readonly` options

options?: LocalPeerCacheDiscoveryOptions

`Private` peers

peers: LocalStoragePeerInfo[] = []

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
- Defined in packages/local-peer-cache-discovery/src/index.ts:47

Methods

addEventListener

addEventListener<K>(type, listener, options?): 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 TypedEventEmitter.addEventListener
- Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:31

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Implementation of PeerDiscovery.dispatchEvent
Inherited from TypedEventEmitter.dispatchEvent
- Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:33

`Private` getPeersFromLocalStorage

getPeersFromLocalStorage(): LocalStoragePeerInfo[]
Returns LocalStoragePeerInfo[]
- Defined in packages/local-peer-cache-discovery/src/index.ts:126

handleNewPeers

handleNewPeers(event): void
Parameters
- event: CustomEvent<IdentifyResult>
Returns void
- Defined in packages/local-peer-cache-discovery/src/index.ts:101

listenerCount

listenerCount(type): number
Parameters
- type: string
Returns number
Implementation of PeerDiscovery.listenerCount
Inherited from TypedEventEmitter.listenerCount
- Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:30

removeEventListener

removeEventListener<K>(type, listener?, options?): 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 TypedEventEmitter.removeEventListener
- Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:32

safeDispatchEvent

safeDispatchEvent<Detail>(type, detail?): boolean
Type Parameters
- Detail
Parameters
- type: "peer"
- Optional detail: CustomEventInit<Detail>
Returns boolean
Implementation of PeerDiscovery.safeDispatchEvent
Inherited from TypedEventEmitter.safeDispatchEvent
- Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:34

`Private` savePeersToLocalStorage

savePeersToLocalStorage(): void
Returns void
- Defined in packages/local-peer-cache-discovery/src/index.ts:138

start

start(): Promise<void>
Returns Promise<void>
Implementation of Startable.start
- Defined in packages/local-peer-cache-discovery/src/index.ts:51

stop

stop(): void | Promise<void>
Returns void | Promise<void>
Implementation of Startable.stop
- Defined in packages/local-peer-cache-discovery/src/index.ts:89

Generated using TypeDoc