From ba0cb9926bfbcec5902938f331912cad165874f3 Mon Sep 17 00:00:00 2001 From: "aegir[bot]" Date: Mon, 4 Dec 2023 14:24:03 +0000 Subject: [PATCH] docs: update documentation [skip ci] --- classes/PubSubPeerDiscovery.html | 12 ++++++------ functions/pubsubPeerDiscovery-1.html | 2 +- interfaces/PubSubPeerDiscoveryComponents.html | 4 ++-- interfaces/PubsubPeerDiscoveryInit.html | 8 ++++---- variables/TOPIC.html | 2 +- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/classes/PubSubPeerDiscovery.html b/classes/PubSubPeerDiscovery.html index 81f2088..cd44554 100644 --- a/classes/PubSubPeerDiscovery.html +++ b/classes/PubSubPeerDiscovery.html @@ -1,5 +1,5 @@ PubSubPeerDiscovery | @libp2p/pubsub-peer-discovery

Class PubSubPeerDiscovery

A Peer Discovery Service that leverages libp2p Pubsub to find peers.

-

Hierarchy

Implements

Constructors

constructor +

Hierarchy

Implements

Constructors

constructor

Properties

#private [peerDiscoverySymbol] [toStringTag] @@ -21,9 +21,9 @@ safeDispatchEvent start stop -

Constructors

constructor

Properties

Private #private

#private: any

Readonly [peerDiscoverySymbol]

[peerDiscoverySymbol]: true = true

Readonly [toStringTag]

[toStringTag]: "@libp2p/pubsub-peer-discovery" = '@libp2p/pubsub-peer-discovery'

Private Readonly components

components: PubSubPeerDiscoveryComponents

Private Readonly interval

interval: number

Private Optional intervalId

intervalId?: Timeout

Private Readonly listenOnly

listenOnly: boolean

Private Readonly log

log: Logger

Private Readonly topics

topics: string[]

Methods

_broadcast

  • _broadcast(): void

  • Performs a broadcast via Pubsub publish

    -

    Returns void

_onMessage

addEventListener

  • addEventListener<K>(type, listener, options?): void

  • Type Parameters

    • K extends "peer"

    Parameters

    Returns void

afterStart

  • afterStart(): void

  • Subscribes to the discovery topic on libp2p.pubsub and performs a broadcast +

Constructors

constructor

Properties

Private #private

#private: any

Readonly [peerDiscoverySymbol]

[peerDiscoverySymbol]: true = true

Readonly [toStringTag]

[toStringTag]: "@libp2p/pubsub-peer-discovery" = '@libp2p/pubsub-peer-discovery'

Private Readonly components

components: PubSubPeerDiscoveryComponents

Private Readonly interval

interval: number

Private Optional intervalId

intervalId?: Timeout

Private Readonly listenOnly

listenOnly: boolean

Private Readonly log

log: Logger

Private Readonly topics

topics: string[]

Methods

_broadcast

  • _broadcast(): void

  • Performs a broadcast via Pubsub publish

    +

    Returns void

_onMessage

addEventListener

  • addEventListener<K>(type, listener, options?): void

  • Type Parameters

    • K extends "peer"

    Parameters

    Returns void

afterStart

  • afterStart(): void

  • Subscribes to the discovery topic on libp2p.pubsub and performs a broadcast immediately, and every this.interval

    -

    Returns void

beforeStop

  • beforeStop(): void

  • Returns void

dispatchEvent

  • dispatchEvent(event): boolean

  • Parameters

    Returns boolean

isStarted

listenerCount

  • listenerCount(type): number

  • Parameters

    • type: string

    Returns number

removeEventListener

  • removeEventListener<K>(type, listener?, options?): void

  • Type Parameters

    • K extends "peer"

    Parameters

    Returns void

safeDispatchEvent

  • safeDispatchEvent<Detail>(type, detail): boolean

  • Type Parameters

    • Detail

    Parameters

    • type: "peer"
    • detail: CustomEventInit<Detail>

    Returns boolean

start

  • start(): void

  • Returns void

stop

  • stop(): void

  • Unsubscribes from the discovery topic

    -

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns void

beforeStop

dispatchEvent

isStarted

listenerCount

removeEventListener

safeDispatchEvent

start

stop

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/pubsubPeerDiscovery-1.html b/functions/pubsubPeerDiscovery-1.html index a70d57a..2046ad1 100644 --- a/functions/pubsubPeerDiscovery-1.html +++ b/functions/pubsubPeerDiscovery-1.html @@ -1 +1 @@ -pubsubPeerDiscovery | @libp2p/pubsub-peer-discovery

Function pubsubPeerDiscovery

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +pubsubPeerDiscovery | @libp2p/pubsub-peer-discovery

Function pubsubPeerDiscovery

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/PubSubPeerDiscoveryComponents.html b/interfaces/PubSubPeerDiscoveryComponents.html index 15be7a6..bbd2905 100644 --- a/interfaces/PubSubPeerDiscoveryComponents.html +++ b/interfaces/PubSubPeerDiscoveryComponents.html @@ -1,5 +1,5 @@ -PubSubPeerDiscoveryComponents | @libp2p/pubsub-peer-discovery

Interface PubSubPeerDiscoveryComponents

interface PubSubPeerDiscoveryComponents {
    addressManager: AddressManager;
    logger: ComponentLogger;
    peerId: PeerId;
    pubsub?: PubSub<PubSubEvents>;
}

Properties

addressManager +PubSubPeerDiscoveryComponents | @libp2p/pubsub-peer-discovery

Interface PubSubPeerDiscoveryComponents

interface PubSubPeerDiscoveryComponents {
    addressManager: AddressManager;
    logger: ComponentLogger;
    peerId: PeerId;
    pubsub?: PubSub<PubSubEvents>;
}

Properties

addressManager logger peerId pubsub? -

Properties

addressManager

addressManager: AddressManager

logger

logger: ComponentLogger

peerId

peerId: PeerId

Optional pubsub

pubsub?: PubSub<PubSubEvents>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

addressManager

addressManager: AddressManager

logger

logger: ComponentLogger

peerId

peerId: PeerId

Optional pubsub

pubsub?: PubSub<PubSubEvents>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/PubsubPeerDiscoveryInit.html b/interfaces/PubsubPeerDiscoveryInit.html index a8e2b0e..1e7cb59 100644 --- a/interfaces/PubsubPeerDiscoveryInit.html +++ b/interfaces/PubsubPeerDiscoveryInit.html @@ -1,7 +1,7 @@ -PubsubPeerDiscoveryInit | @libp2p/pubsub-peer-discovery

Interface PubsubPeerDiscoveryInit

interface PubsubPeerDiscoveryInit {
    interval?: number;
    listenOnly?: boolean;
    topics?: string[];
}

Properties

interval? +PubsubPeerDiscoveryInit | @libp2p/pubsub-peer-discovery

Interface PubsubPeerDiscoveryInit

interface PubsubPeerDiscoveryInit {
    interval?: number;
    listenOnly?: boolean;
    topics?: string[];
}

Properties

interval? listenOnly? topics?

Properties

Optional interval

interval?: number

How often (ms) we should broadcast our infos

-

Optional listenOnly

listenOnly?: boolean

If true, we will not broadcast our peer data

-

Optional topics

topics?: string[]

What topics to subscribe to. If set, the default will NOT be used.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional listenOnly

listenOnly?: boolean

If true, we will not broadcast our peer data

+

Optional topics

topics?: string[]

What topics to subscribe to. If set, the default will NOT be used.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/TOPIC.html b/variables/TOPIC.html index 21ea418..d7ed446 100644 --- a/variables/TOPIC.html +++ b/variables/TOPIC.html @@ -1 +1 @@ -TOPIC | @libp2p/pubsub-peer-discovery

Variable TOPICConst

TOPIC: "_peer-discovery._p2p._pubsub" = '_peer-discovery._p2p._pubsub'

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +TOPIC | @libp2p/pubsub-peer-discovery

Variable TOPICConst

TOPIC: "_peer-discovery._p2p._pubsub" = '_peer-discovery._p2p._pubsub'

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file