diff --git a/classes/_libp2p_interface.AbortError.html b/classes/_libp2p_interface.AbortError.html index 7b1931656a..d9a27fb745 100644 --- a/classes/_libp2p_interface.AbortError.html +++ b/classes/_libp2p_interface.AbortError.html @@ -1,7 +1,7 @@ AbortError | libp2p

Class AbortError

When this error is thrown it means an operation was aborted, usually in response to the abort event being emitted by an AbortSignal.

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

cause? message name @@ -10,7 +10,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'AbortError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'AbortError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.AlreadyStartedError.html b/classes/_libp2p_interface.AlreadyStartedError.html index c4ce6592ef..d62b46f4aa 100644 --- a/classes/_libp2p_interface.AlreadyStartedError.html +++ b/classes/_libp2p_interface.AlreadyStartedError.html @@ -1,5 +1,5 @@ AlreadyStartedError | libp2p

Class AlreadyStartedError

Thrown when a component is started that has already been started

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'AlreadyStartedError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'AlreadyStartedError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.ConnectionClosedError.html b/classes/_libp2p_interface.ConnectionClosedError.html index 8ed59b0d86..5d6b6efb72 100644 --- a/classes/_libp2p_interface.ConnectionClosedError.html +++ b/classes/_libp2p_interface.ConnectionClosedError.html @@ -1,5 +1,5 @@ ConnectionClosedError | libp2p

Class ConnectionClosedError

Thrown when a connection is closed

-

Hierarchy

  • Error
    • ConnectionClosedError

Constructors

constructor +

Hierarchy

  • Error
    • ConnectionClosedError

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'ConnectionClosedError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'ConnectionClosedError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.ConnectionClosingError.html b/classes/_libp2p_interface.ConnectionClosingError.html index abce2992db..8f621278ea 100644 --- a/classes/_libp2p_interface.ConnectionClosingError.html +++ b/classes/_libp2p_interface.ConnectionClosingError.html @@ -1,5 +1,5 @@ ConnectionClosingError | libp2p

Class ConnectionClosingError

Thrown when a connection is closing

-

Hierarchy

  • Error
    • ConnectionClosingError

Constructors

constructor +

Hierarchy

  • Error
    • ConnectionClosingError

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'ConnectionClosingError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'ConnectionClosingError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.ConnectionFailedError.html b/classes/_libp2p_interface.ConnectionFailedError.html index 58ed30c720..f441fe8678 100644 --- a/classes/_libp2p_interface.ConnectionFailedError.html +++ b/classes/_libp2p_interface.ConnectionFailedError.html @@ -1,5 +1,5 @@ ConnectionFailedError | libp2p

Class ConnectionFailedError

Thrown when a connection fails

-

Hierarchy

  • Error
    • ConnectionFailedError

Constructors

constructor +

Hierarchy

  • Error
    • ConnectionFailedError

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'ConnectionFailedError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'ConnectionFailedError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.DialError.html b/classes/_libp2p_interface.DialError.html index 99034aad66..d0aa4d454a 100644 --- a/classes/_libp2p_interface.DialError.html +++ b/classes/_libp2p_interface.DialError.html @@ -1,5 +1,5 @@ DialError | libp2p

Class DialError

Thrown when dialing an address failed

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'DialError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'DialError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.InvalidCIDError.html b/classes/_libp2p_interface.InvalidCIDError.html index 1772508489..e008481cbf 100644 --- a/classes/_libp2p_interface.InvalidCIDError.html +++ b/classes/_libp2p_interface.InvalidCIDError.html @@ -1,5 +1,5 @@ InvalidCIDError | libp2p

Class InvalidCIDError

Thrown when an invalid CID is encountered

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'InvalidCIDError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'InvalidCIDError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.InvalidCryptoExchangeError.html b/classes/_libp2p_interface.InvalidCryptoExchangeError.html index 68946f0a4e..0cdd6d39e3 100644 --- a/classes/_libp2p_interface.InvalidCryptoExchangeError.html +++ b/classes/_libp2p_interface.InvalidCryptoExchangeError.html @@ -1,5 +1,5 @@ InvalidCryptoExchangeError | libp2p

Class InvalidCryptoExchangeError

Thrown when a crypto exchange fails

-

Hierarchy

  • Error
    • InvalidCryptoExchangeError

Constructors

constructor +

Hierarchy

  • Error
    • InvalidCryptoExchangeError

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'InvalidCryptoExchangeError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'InvalidCryptoExchangeError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.InvalidMessageError.html b/classes/_libp2p_interface.InvalidMessageError.html index e3fff006d5..3cea5077cd 100644 --- a/classes/_libp2p_interface.InvalidMessageError.html +++ b/classes/_libp2p_interface.InvalidMessageError.html @@ -1,5 +1,5 @@ InvalidMessageError | libp2p

Class InvalidMessageError

An invalid or malformed message was encountered during a protocol exchange

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'InvalidMessageError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'InvalidMessageError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.InvalidMultiaddrError.html b/classes/_libp2p_interface.InvalidMultiaddrError.html index 523628bfef..c3a57dded0 100644 --- a/classes/_libp2p_interface.InvalidMultiaddrError.html +++ b/classes/_libp2p_interface.InvalidMultiaddrError.html @@ -1,5 +1,5 @@ InvalidMultiaddrError | libp2p

Class InvalidMultiaddrError

Thrown when an invalid multiaddr is encountered

-

Hierarchy

  • Error
    • InvalidMultiaddrError

Constructors

constructor +

Hierarchy

  • Error
    • InvalidMultiaddrError

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'InvalidMultiaddrError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'InvalidMultiaddrError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.InvalidMultihashError.html b/classes/_libp2p_interface.InvalidMultihashError.html index a66e7d7f97..55814096a9 100644 --- a/classes/_libp2p_interface.InvalidMultihashError.html +++ b/classes/_libp2p_interface.InvalidMultihashError.html @@ -1,5 +1,5 @@ InvalidMultihashError | libp2p

Class InvalidMultihashError

Thrown when an invalid multihash is encountered

-

Hierarchy

  • Error
    • InvalidMultihashError

Constructors

constructor +

Hierarchy

  • Error
    • InvalidMultihashError

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'InvalidMultihashError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'InvalidMultihashError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.InvalidParametersError.html b/classes/_libp2p_interface.InvalidParametersError.html index 8fa216167f..aee9c2bc19 100644 --- a/classes/_libp2p_interface.InvalidParametersError.html +++ b/classes/_libp2p_interface.InvalidParametersError.html @@ -1,5 +1,5 @@ InvalidParametersError | libp2p

Class InvalidParametersError

Thrown when invalid parameters are passed to a function or method call

-

Hierarchy

  • Error
    • InvalidParametersError

Constructors

constructor +

Hierarchy

  • Error
    • InvalidParametersError

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'InvalidParametersError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'InvalidParametersError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.InvalidPeerIdError.html b/classes/_libp2p_interface.InvalidPeerIdError.html index d6bca93432..b721b85d6c 100644 --- a/classes/_libp2p_interface.InvalidPeerIdError.html +++ b/classes/_libp2p_interface.InvalidPeerIdError.html @@ -1,5 +1,5 @@ InvalidPeerIdError | libp2p

Class InvalidPeerIdError

Thrown when an invalid peer ID is encountered

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'InvalidPeerIdError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'InvalidPeerIdError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.InvalidPrivateKeyError.html b/classes/_libp2p_interface.InvalidPrivateKeyError.html index ac10b688c1..3ea439652c 100644 --- a/classes/_libp2p_interface.InvalidPrivateKeyError.html +++ b/classes/_libp2p_interface.InvalidPrivateKeyError.html @@ -1,5 +1,5 @@ InvalidPrivateKeyError | libp2p

Class InvalidPrivateKeyError

Thrown when a private key is invalid

-

Hierarchy

  • Error
    • InvalidPrivateKeyError

Constructors

constructor +

Hierarchy

  • Error
    • InvalidPrivateKeyError

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'InvalidPrivateKeyError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'InvalidPrivateKeyError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.InvalidPublicKeyError.html b/classes/_libp2p_interface.InvalidPublicKeyError.html index 437a7d3717..7d709ead13 100644 --- a/classes/_libp2p_interface.InvalidPublicKeyError.html +++ b/classes/_libp2p_interface.InvalidPublicKeyError.html @@ -1,5 +1,5 @@ InvalidPublicKeyError | libp2p

Class InvalidPublicKeyError

Thrown when a public key is invalid

-

Hierarchy

  • Error
    • InvalidPublicKeyError

Constructors

constructor +

Hierarchy

  • Error
    • InvalidPublicKeyError

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'InvalidPublicKeyError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'InvalidPublicKeyError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.LimitedConnectionError.html b/classes/_libp2p_interface.LimitedConnectionError.html index 708a9498ba..51c17095ff 100644 --- a/classes/_libp2p_interface.LimitedConnectionError.html +++ b/classes/_libp2p_interface.LimitedConnectionError.html @@ -1,7 +1,7 @@ LimitedConnectionError | libp2p

Class LimitedConnectionError

This error is thrown when a limited connection is encountered, i.e. if the user tried to open a stream on a connection for a protocol that is not configured to run over limited connections.

-

Hierarchy

  • Error
    • LimitedConnectionError

Constructors

constructor +

Hierarchy

  • Error
    • LimitedConnectionError

Constructors

constructor

Properties

cause? message name @@ -10,7 +10,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'LimitedConnectionError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'LimitedConnectionError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.ListenError.html b/classes/_libp2p_interface.ListenError.html index a863b2119d..3e05ab5f2a 100644 --- a/classes/_libp2p_interface.ListenError.html +++ b/classes/_libp2p_interface.ListenError.html @@ -1,5 +1,5 @@ ListenError | libp2p

Class ListenError

Thrown when listening on an address failed

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'ListenError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'ListenError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.MuxerClosedError.html b/classes/_libp2p_interface.MuxerClosedError.html index eecee67d54..6c451ac949 100644 --- a/classes/_libp2p_interface.MuxerClosedError.html +++ b/classes/_libp2p_interface.MuxerClosedError.html @@ -1,5 +1,5 @@ MuxerClosedError | libp2p

Class MuxerClosedError

Thrown when the muxer is closed and an attempt to open a stream occurs

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'MuxerClosedError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'MuxerClosedError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.NotFoundError.html b/classes/_libp2p_interface.NotFoundError.html index 5255a0fcf2..13a691d417 100644 --- a/classes/_libp2p_interface.NotFoundError.html +++ b/classes/_libp2p_interface.NotFoundError.html @@ -1,5 +1,5 @@ NotFoundError | libp2p

Class NotFoundError

Thrown when a value could not be found

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'NotFoundError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'NotFoundError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.NotStartedError.html b/classes/_libp2p_interface.NotStartedError.html index 2a6f86b50a..5d0d3cd0ba 100644 --- a/classes/_libp2p_interface.NotStartedError.html +++ b/classes/_libp2p_interface.NotStartedError.html @@ -1,6 +1,6 @@ NotStartedError | libp2p

Class NotStartedError

Thrown when a startable component is interacted with but it has not been started yet

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

cause? message name @@ -9,7 +9,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'NotStartedError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'NotStartedError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.ProtocolError.html b/classes/_libp2p_interface.ProtocolError.html index 20375a66a6..d5c5aad4b5 100644 --- a/classes/_libp2p_interface.ProtocolError.html +++ b/classes/_libp2p_interface.ProtocolError.html @@ -1,6 +1,6 @@ ProtocolError | libp2p

Class ProtocolError

Thrown when a remote peer sends a structurally valid message that does not comply with the protocol

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

cause? message name @@ -9,7 +9,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'ProtocolError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'ProtocolError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.StreamResetError.html b/classes/_libp2p_interface.StreamResetError.html index d03f267ab8..cdbde9820f 100644 --- a/classes/_libp2p_interface.StreamResetError.html +++ b/classes/_libp2p_interface.StreamResetError.html @@ -1,5 +1,5 @@ StreamResetError | libp2p

Class StreamResetError

Thrown when a protocol stream is reset by the remote muxer

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'StreamResetError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'StreamResetError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.StreamStateError.html b/classes/_libp2p_interface.StreamStateError.html index 78e3594808..83c5508a15 100644 --- a/classes/_libp2p_interface.StreamStateError.html +++ b/classes/_libp2p_interface.StreamStateError.html @@ -1,5 +1,5 @@ StreamStateError | libp2p

Class StreamStateError

Thrown when a stream is in an invalid state

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'StreamStateError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'StreamStateError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.TimeoutError.html b/classes/_libp2p_interface.TimeoutError.html index 0d598a6b2b..dda178cf43 100644 --- a/classes/_libp2p_interface.TimeoutError.html +++ b/classes/_libp2p_interface.TimeoutError.html @@ -1,5 +1,5 @@ TimeoutError | libp2p

Class TimeoutError

Throw when an operation times out

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'TimeoutError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'TimeoutError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.TooManyInboundProtocolStreamsError.html b/classes/_libp2p_interface.TooManyInboundProtocolStreamsError.html index 3199bddbcb..b2f0afda22 100644 --- a/classes/_libp2p_interface.TooManyInboundProtocolStreamsError.html +++ b/classes/_libp2p_interface.TooManyInboundProtocolStreamsError.html @@ -1,5 +1,5 @@ TooManyInboundProtocolStreamsError | libp2p

Class TooManyInboundProtocolStreamsError

This error is thrown where there are too many inbound protocols streams open

-

Hierarchy

  • Error
    • TooManyInboundProtocolStreamsError

Constructors

constructor +

Hierarchy

  • Error
    • TooManyInboundProtocolStreamsError

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'TooManyInboundProtocolStreamsError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'TooManyInboundProtocolStreamsError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.TooManyOutboundProtocolStreamsError.html b/classes/_libp2p_interface.TooManyOutboundProtocolStreamsError.html index ffd2ea0c8c..3c019e41e1 100644 --- a/classes/_libp2p_interface.TooManyOutboundProtocolStreamsError.html +++ b/classes/_libp2p_interface.TooManyOutboundProtocolStreamsError.html @@ -1,5 +1,5 @@ TooManyOutboundProtocolStreamsError | libp2p

Class TooManyOutboundProtocolStreamsError

This error is thrown where there are too many outbound protocols streams open

-

Hierarchy

  • Error
    • TooManyOutboundProtocolStreamsError

Constructors

constructor +

Hierarchy

  • Error
    • TooManyOutboundProtocolStreamsError

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'TooManyOutboundProtocolStreamsError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'TooManyOutboundProtocolStreamsError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.TypedEventEmitter.html b/classes/_libp2p_interface.TypedEventEmitter.html index c5ab809cca..dd12c3e32e 100644 --- a/classes/_libp2p_interface.TypedEventEmitter.html +++ b/classes/_libp2p_interface.TypedEventEmitter.html @@ -1,12 +1,12 @@ TypedEventEmitter | libp2p

Class TypedEventEmitter<EventMap>

An implementation of a typed event target etc

-

Type Parameters

  • EventMap extends Record<string, any>

Hierarchy

Implements

Constructors

constructor +

Type Parameters

  • EventMap extends Record<string, any>

Hierarchy

Implements

Constructors

constructor

Properties

#listeners

Methods

addEventListener dispatchEvent listenerCount removeEventListener safeDispatchEvent -

Constructors

constructor

Properties

Private Readonly #listeners

#listeners: Map<any, Listener[]> = ...

Methods

addEventListener

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    +

Constructors

constructor

Properties

Private Readonly #listeners

#listeners: Map<any, Listener[]> = ...

Methods

addEventListener

dispatchEvent

listenerCount

removeEventListener

safeDispatchEvent

Settings

Member Visibility

Theme

On This Page

constructor#listenersaddEventListenerdispatchEventlistenerCountremoveEventListenersafeDispatchEvent
\ No newline at end of file +

Parameters

Returns boolean

listenerCount

removeEventListener

safeDispatchEvent

Settings

Member Visibility

Theme

On This Page

constructor#listenersaddEventListenerdispatchEventlistenerCountremoveEventListenersafeDispatchEvent
\ No newline at end of file diff --git a/classes/_libp2p_interface.UnexpectedPeerError.html b/classes/_libp2p_interface.UnexpectedPeerError.html index cdbd917e02..fe94183a58 100644 --- a/classes/_libp2p_interface.UnexpectedPeerError.html +++ b/classes/_libp2p_interface.UnexpectedPeerError.html @@ -1,5 +1,5 @@ UnexpectedPeerError | libp2p

Class UnexpectedPeerError

Thrown when a remote Peer ID does not match the expected one

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'UnexpectedPeerError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'UnexpectedPeerError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.UnsupportedKeyTypeError.html b/classes/_libp2p_interface.UnsupportedKeyTypeError.html index 33003f2c06..d5b1e6d18f 100644 --- a/classes/_libp2p_interface.UnsupportedKeyTypeError.html +++ b/classes/_libp2p_interface.UnsupportedKeyTypeError.html @@ -1,5 +1,5 @@ UnsupportedKeyTypeError | libp2p

Class UnsupportedKeyTypeError

Thrown when and attempt to operate on an unsupported key was made

-

Hierarchy

  • Error
    • UnsupportedKeyTypeError

Constructors

constructor +

Hierarchy

  • Error
    • UnsupportedKeyTypeError

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'UnsupportedKeyTypeError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'UnsupportedKeyTypeError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.UnsupportedOperationError.html b/classes/_libp2p_interface.UnsupportedOperationError.html index d146e74e62..b8991357b9 100644 --- a/classes/_libp2p_interface.UnsupportedOperationError.html +++ b/classes/_libp2p_interface.UnsupportedOperationError.html @@ -1,5 +1,5 @@ UnsupportedOperationError | libp2p

Class UnsupportedOperationError

Thrown when a operation is unsupported

-

Hierarchy

  • Error
    • UnsupportedOperationError

Constructors

constructor +

Hierarchy

  • Error
    • UnsupportedOperationError

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'UnsupportedOperationError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'UnsupportedOperationError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface.UnsupportedProtocolError.html b/classes/_libp2p_interface.UnsupportedProtocolError.html index cf76bcde4c..dae0909ff4 100644 --- a/classes/_libp2p_interface.UnsupportedProtocolError.html +++ b/classes/_libp2p_interface.UnsupportedProtocolError.html @@ -1,5 +1,5 @@ UnsupportedProtocolError | libp2p

Class UnsupportedProtocolError

Thrown when a protocol is not supported

-

Hierarchy

  • Error
    • UnsupportedProtocolError

Constructors

constructor +

Hierarchy

  • Error
    • UnsupportedProtocolError

Constructors

constructor

Properties

cause? message name @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'UnsupportedProtocolError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static name

name: string = 'UnsupportedProtocolError'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestacknameprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_interface_compliance_tests.mocks.MockNetwork.html b/classes/_libp2p_interface_compliance_tests.mocks.MockNetwork.html index bc37d16c9a..e2020a97c4 100644 --- a/classes/_libp2p_interface_compliance_tests.mocks.MockNetwork.html +++ b/classes/_libp2p_interface_compliance_tests.mocks.MockNetwork.html @@ -1,6 +1,6 @@ -MockNetwork | libp2p

Class MockNetwork

Constructors

constructor +MockNetwork | libp2p

Class MockNetwork

Constructors

constructor

Properties

components

Methods

addNode getNode reset -

Constructors

constructor

Properties

Private components

components: MockNetworkComponents[] = []

Methods

addNode

getNode

reset

Settings

Member Visibility

Theme

On This Page

constructorcomponentsaddNodegetNodereset
\ No newline at end of file +

Constructors

constructor

Properties

Private components

components: MockNetworkComponents[] = []

Methods

addNode

getNode

reset

Settings

Member Visibility

Theme

On This Page

constructorcomponentsaddNodegetNodereset
\ No newline at end of file diff --git a/classes/_libp2p_peer_collections.PeerFilter.html b/classes/_libp2p_peer_collections.PeerFilter.html index 2961ed2933..b8f37efb6b 100644 --- a/classes/_libp2p_peer_collections.PeerFilter.html +++ b/classes/_libp2p_peer_collections.PeerFilter.html @@ -1,8 +1,8 @@ PeerFilter | libp2p

Class PeerFilter

Uses a Cuckoo filter to implement a mechanism for deduplicating PeerIds in a way that uses a smaller amount of memory than a PeerSet.

-

Constructors

constructor +

Constructors

constructor

Properties

filter

Methods

add has remove -

Constructors

constructor

Properties

Private Readonly filter

filter: Filter

Methods

add

has

remove

Settings

Member Visibility

Theme

On This Page

constructorfilteraddhasremove
\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly filter

filter: Filter

Methods

add

has

remove

Settings

Member Visibility

Theme

On This Page

constructorfilteraddhasremove
\ No newline at end of file diff --git a/classes/_libp2p_peer_collections.PeerList.html b/classes/_libp2p_peer_collections.PeerList.html index cd2e177644..24cf00af18 100644 --- a/classes/_libp2p_peer_collections.PeerList.html +++ b/classes/_libp2p_peer_collections.PeerList.html @@ -5,7 +5,7 @@ should be a cheap operation.

Example

import { peerList } from '@libp2p/peer-collections'

const list = peerList()
list.push(peerId)
-

Constructors

constructor +

Constructors

constructor

Properties

list

Accessors

length

Methods

[iterator] @@ -23,4 +23,4 @@ push shift unshift -

Constructors

constructor

Properties

Private list

list: PeerId[]

Accessors

length

  • get length(): number

  • Returns number

Methods

[iterator]

clear

concat

entries

every

  • every(predicate): boolean

  • Parameters

    • predicate: ((peerId, index, arr) => boolean)
        • (peerId, index, arr): boolean

        • Parameters

          Returns boolean

    Returns boolean

filter

  • filter(predicate): PeerList

  • Parameters

    • predicate: ((peerId, index, arr) => boolean)
        • (peerId, index, arr): boolean

        • Parameters

          Returns boolean

    Returns PeerList

find

  • find(predicate): undefined | PeerId

  • Parameters

    • predicate: ((peerId, index, arr) => boolean)
        • (peerId, index, arr): boolean

        • Parameters

          Returns boolean

    Returns undefined | PeerId

findIndex

  • findIndex(predicate): number

  • Parameters

    • predicate: ((peerId, index, arr) => boolean)
        • (peerId, index, arr): boolean

        • Parameters

          Returns boolean

    Returns number

forEach

  • forEach(predicate): void

  • Parameters

    • predicate: ((peerId, index, arr) => void)
        • (peerId, index, arr): void

        • Parameters

          Returns void

    Returns void

includes

  • includes(peerId): boolean

  • Parameters

    Returns boolean

indexOf

pop

push

  • push(...peerIds): void

  • Parameters

    Returns void

shift

unshift

  • unshift(...peerIds): number

  • Parameters

    Returns number

Settings

Member Visibility

Theme

On This Page

constructorlistlength[iterator]clearconcatentrieseveryfilterfindfindIndexforEachincludesindexOfpoppushshiftunshift
\ No newline at end of file +

Constructors

constructor

Properties

Private list

list: PeerId[]

Accessors

length

Methods

[iterator]

clear

concat

entries

every

filter

find

findIndex

forEach

includes

indexOf

pop

push

shift

unshift

Settings

Member Visibility

Theme

On This Page

constructorlistlength[iterator]clearconcatentrieseveryfilterfindfindIndexforEachincludesindexOfpoppushshiftunshift
\ No newline at end of file diff --git a/classes/_libp2p_peer_collections.PeerMap.html b/classes/_libp2p_peer_collections.PeerMap.html index ee29aceba1..6af5ba841a 100644 --- a/classes/_libp2p_peer_collections.PeerMap.html +++ b/classes/_libp2p_peer_collections.PeerMap.html @@ -5,7 +5,7 @@ should be a cheap operation.

Example

import { peerMap } from '@libp2p/peer-collections'

const map = peerMap<string>()
map.set(peerId, 'value')
-

Type Parameters

Constructors

constructor +

Type Parameters

  • T

Constructors

constructor

Properties

map

Accessors

size

Methods

[iterator] @@ -18,4 +18,4 @@ keys set values -

Constructors

constructor

Properties

Private Readonly map

map: Map<string, {
    key: PeerId;
    value: T;
}>

Type declaration

Accessors

size

  • get size(): number

  • Returns number

Methods

[iterator]

clear

  • clear(): void

  • Returns void

delete

  • delete(peer): boolean

  • Parameters

    Returns boolean

entries

forEach

  • forEach(fn): void

  • Parameters

    • fn: ((value, key, map) => void)
        • (value, key, map): void

        • Parameters

          Returns void

    Returns void

get

  • get(peer): undefined | T

  • Parameters

    Returns undefined | T

has

  • has(peer): boolean

  • Parameters

    Returns boolean

keys

set

  • set(peer, value): void

  • Parameters

    Returns void

values

  • values(): IterableIterator<T>

  • Returns IterableIterator<T>

Settings

Member Visibility

Theme

On This Page

constructormapsize[iterator]cleardeleteentriesforEachgethaskeyssetvalues
\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly map

map: Map<string, {
    key: PeerId;
    value: T;
}>

Type declaration

Accessors

size

Methods

[iterator]

clear

delete

entries

forEach

get

has

keys

set

values

Settings

Member Visibility

Theme

On This Page

constructormapsize[iterator]cleardeleteentriesforEachgethaskeyssetvalues
\ No newline at end of file diff --git a/classes/_libp2p_peer_collections.PeerSet.html b/classes/_libp2p_peer_collections.PeerSet.html index 2cf7269bf9..a7380d6c88 100644 --- a/classes/_libp2p_peer_collections.PeerSet.html +++ b/classes/_libp2p_peer_collections.PeerSet.html @@ -5,7 +5,7 @@ should be a cheap operation.

Example

import { peerSet } from '@libp2p/peer-collections'

const set = peerSet()
set.add(peerId)
-

Constructors

constructor +

Constructors

constructor

Properties

set

Accessors

size

Methods

[iterator] @@ -19,4 +19,4 @@ intersection union values -

Constructors

constructor

Properties

Private Readonly set

set: Set<string>

Accessors

size

  • get size(): number

  • Returns number

Methods

[iterator]

add

clear

  • clear(): void

  • Returns void

delete

difference

entries

forEach

  • forEach(predicate): void

  • Parameters

    • predicate: ((peerId, index, set) => void)

    Returns void

has

  • has(peer): boolean

  • Parameters

    Returns boolean

intersection

union

values

Settings

Member Visibility

Theme

On This Page

constructorsetsize[iterator]addcleardeletedifferenceentriesforEachhasintersectionunionvalues
\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly set

set: Set<string>

Accessors

size

Methods

[iterator]

add

clear

delete

difference

entries

forEach

has

intersection

union

values

Settings

Member Visibility

Theme

On This Page

constructorsetsize[iterator]addcleardeletedifferenceentriesforEachhasintersectionunionvalues
\ No newline at end of file diff --git a/classes/_libp2p_peer_record.PeerRecord.html b/classes/_libp2p_peer_record.PeerRecord.html index 3a67d0844f..0a3469f16c 100644 --- a/classes/_libp2p_peer_record.PeerRecord.html +++ b/classes/_libp2p_peer_record.PeerRecord.html @@ -1,6 +1,6 @@ PeerRecord | libp2p

Class PeerRecord

The PeerRecord is used for distributing peer routing records across the network. It contains the peer's reachable listen addresses.

-

Constructors

constructor +

Constructors

constructor

Properties

codec domain marshaled? @@ -12,7 +12,7 @@

Methods

equals marshal createFromProtobuf -

Constructors

constructor

Properties

codec

codec: Uint8Array = PeerRecord.CODEC

domain

domain: string = PeerRecord.DOMAIN

Private Optional marshaled

marshaled?: Uint8Array

multiaddrs

multiaddrs: Multiaddr[]

peerId

peerId: PeerId

seqNumber

seqNumber: bigint

Static CODEC

CODEC: Uint8Array = ENVELOPE_PAYLOAD_TYPE_PEER_RECORD

Static DOMAIN

DOMAIN: string = ENVELOPE_DOMAIN_PEER_RECORD

Methods

equals

  • equals(other): boolean

  • Returns true if this record equals the other

    -

    Parameters

    • other: unknown

    Returns boolean

marshal

Static createFromProtobuf

Settings

Member Visibility

Theme

On This Page

constructorcodecdomainmarshaledmultiaddrspeerIdseqNumberCODECDOMAINequalsmarshalcreateFromProtobuf
\ No newline at end of file +

Constructors

constructor

Properties

codec

codec: Uint8Array = PeerRecord.CODEC

domain

domain: string = PeerRecord.DOMAIN

Private Optional marshaled

marshaled?: Uint8Array

multiaddrs

multiaddrs: Multiaddr[]

peerId

peerId: PeerId

seqNumber

seqNumber: bigint

Static CODEC

CODEC: Uint8Array = ENVELOPE_PAYLOAD_TYPE_PEER_RECORD

Static DOMAIN

DOMAIN: string = ENVELOPE_DOMAIN_PEER_RECORD

Methods

equals

marshal

Static createFromProtobuf

Settings

Member Visibility

Theme

On This Page

constructorcodecdomainmarshaledmultiaddrspeerIdseqNumberCODECDOMAINequalsmarshalcreateFromProtobuf
\ No newline at end of file diff --git a/classes/_libp2p_peer_record.RecordEnvelope.html b/classes/_libp2p_peer_record.RecordEnvelope.html index 14ad6ad653..0b548e7437 100644 --- a/classes/_libp2p_peer_record.RecordEnvelope.html +++ b/classes/_libp2p_peer_record.RecordEnvelope.html @@ -1,4 +1,4 @@ -RecordEnvelope | libp2p

Class RecordEnvelope

Implements

Constructors

constructor +RecordEnvelope | libp2p

Class RecordEnvelope

Implements

Constructors

constructor

Properties

marshaled? payload payloadType @@ -12,12 +12,12 @@ seal

Constructors

constructor

Properties

Optional marshaled

marshaled?: Uint8Array

payload

payload: Uint8Array

payloadType

payloadType: Uint8Array

publicKey

publicKey: PublicKey

signature

signature: Uint8Array

Methods

equals

marshal

validate

Static createFromProtobuf

Static openAndCertify

Properties

Optional marshaled

marshaled?: Uint8Array

payload

payload: Uint8Array

payloadType

payloadType: Uint8Array

publicKey

publicKey: PublicKey

signature

signature: Uint8Array

Methods

equals

marshal

validate

Static createFromProtobuf

Static openAndCertify

Static seal

Static seal

Settings

Member Visibility

Theme

On This Page

constructormarshaledpayloadpayloadTypepublicKeysignatureequalsmarshalvalidatecreateFromProtobufopenAndCertifyseal
\ No newline at end of file +

Parameters

Returns Promise<RecordEnvelope>

Settings

Member Visibility

Theme

On This Page

constructormarshaledpayloadpayloadTypepublicKeysignatureequalsmarshalvalidatecreateFromProtobufopenAndCertifyseal
\ No newline at end of file diff --git a/classes/_libp2p_pubsub.index.PubSubBaseProtocol.html b/classes/_libp2p_pubsub.index.PubSubBaseProtocol.html index 1f403b01e1..2e49fdcf95 100644 --- a/classes/_libp2p_pubsub.index.PubSubBaseProtocol.html +++ b/classes/_libp2p_pubsub.index.PubSubBaseProtocol.html @@ -1,6 +1,6 @@ PubSubBaseProtocol | libp2p

Class PubSubBaseProtocol<Events>Abstract

PubSubBaseProtocol handles the peers and connections logic for pubsub routers and specifies the API that pubsub routers should have.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor +

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

#private _registrarTopologyIds canRelayMessage @@ -51,52 +51,52 @@ subscribe unsubscribe validate -

Constructors

constructor

Properties

Private #private

#private: any

Private _registrarTopologyIds

_registrarTopologyIds: undefined | string[]

canRelayMessage

canRelayMessage: boolean

If router can relay received messages, even if not subscribed

-

components

components: PubSubComponents

emitSelf

emitSelf: boolean

if publish should emit to self, if subscribed

-

Protected enabled

enabled: boolean

globalSignaturePolicy

globalSignaturePolicy: "StrictSign" | "StrictNoSign"

The signature policy to follow by default

-

Protected log

log: Logger

Private Readonly maxInboundStreams

maxInboundStreams: number

Private Readonly maxOutboundStreams

maxOutboundStreams: number

multicodecs

multicodecs: string[]

A list of multicodecs that contain the pubsub protocol name.

-

peers

peers: PeerMap<PeerStreams>

Map of peer streams

-

queue

queue: default<default, QueueAddOptions>

started

started: boolean

subscriptions

subscriptions: Set<string>

List of our subscriptions

-

topicValidators

topicValidators: Map<string, TopicValidatorFn>

Topic validator map

+

Constructors

constructor

Properties

Private #private

#private: any

Private _registrarTopologyIds

_registrarTopologyIds: undefined | string[]

canRelayMessage

canRelayMessage: boolean

If router can relay received messages, even if not subscribed

+

components

components: PubSubComponents

emitSelf

emitSelf: boolean

if publish should emit to self, if subscribed

+

Protected enabled

enabled: boolean

globalSignaturePolicy

globalSignaturePolicy: "StrictSign" | "StrictNoSign"

The signature policy to follow by default

+

Protected log

log: Logger

Private Readonly maxInboundStreams

maxInboundStreams: number

Private Readonly maxOutboundStreams

maxOutboundStreams: number

multicodecs

multicodecs: string[]

A list of multicodecs that contain the pubsub protocol name.

+

peers

peers: PeerMap<PeerStreams>

Map of peer streams

+

queue

queue: default<default, QueueAddOptions>

started

started: boolean

subscriptions

subscriptions: Set<string>

List of our subscriptions

+

topicValidators

topicValidators: Map<string, TopicValidatorFn>

Topic validator map

Keyed by topic Topic validators are functions with the following input:

-

topics

topics: Map<string, PeerSet>

Map of topics to which peers are subscribed to

-

Methods

Protected _onIncomingStream

Protected _onPeerConnected

Protected _onPeerDisconnected

  • _onPeerDisconnected(peerId, conn?): void

  • Registrar notifies a closing connection with pubsub protocol

    -

    Parameters

    Returns void

Protected _removePeer

acceptFrom

topics

topics: Map<string, PeerSet>

Map of topics to which peers are subscribed to

+

Methods

Protected _onIncomingStream

Protected _onPeerConnected

Protected _onPeerDisconnected

  • _onPeerDisconnected(peerId, conn?): void

  • Registrar notifies a closing connection with pubsub protocol

    +

    Parameters

    Returns void

Protected _removePeer

acceptFrom

  • acceptFrom(id): boolean

  • Whether to accept a message from a peer Override to create a graylist

    -

    Parameters

    Returns boolean

addEventListener

addPeer

buildMessage

addEventListener

addPeer

buildMessage

  • buildMessage(message): Promise<Message>

  • Normalizes the message and signs it, if signing is enabled. Should be used by the routers to create the message to send.

    -

    Parameters

    • message: {
          data: Uint8Array;
          from: PeerId;
          sequenceNumber: bigint;
          topic: string;
      }

    Returns Promise<Message>

Abstract decodeRpc

Abstract decodeRpc

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    +

    Parameters

    Returns PubSubRPC

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    Returns boolean

Abstract encodeMessage

Abstract encodeRpc

Abstract encodeRpc

getMsgId

getMsgId

getPeers

getSubscribers

getTopics

isStarted

listenerCount

processMessage

processMessages

processRpc

processRpcSubOpt

publish

Abstract publishMessage

getPeers

getSubscribers

getTopics

isStarted

listenerCount

processMessage

processMessages

processRpc

processRpcSubOpt

publish

Abstract publishMessage

  • publishMessage(sender, message): Promise<PublishResult>

  • Overriding the implementation of publish should handle the appropriate algorithms for the publish/subscriber implementation. For example, a Floodsub implementation might simply publish each message to each topic for every peer.

    sender might be this peer, or we might be forwarding a message on behalf of another peer, in which case sender is the peer we received the message from, which may not be the peer the message was created by.

    -

    Parameters

    Returns Promise<PublishResult>

removeEventListener

safeDispatchEvent

send

  • send(peer, data): void

  • Send an rpc object to a peer

    -

    Parameters

    • peer: PeerId
    • data: {
          messages?: Message[];
          subscribe?: boolean;
          subscriptions?: string[];
      }
      • Optional messages?: Message[]
      • Optional subscribe?: boolean
      • Optional subscriptions?: string[]

    Returns void

sendRpc

start

stop

subscribe

unsubscribe

validate

removeEventListener

safeDispatchEvent

send

  • send(peer, data): void

  • Send an rpc object to a peer

    +

    Parameters

    • peer: PeerId
    • data: {
          messages?: Message[];
          subscribe?: boolean;
          subscriptions?: string[];
      }
      • Optional messages?: Message[]
      • Optional subscribe?: boolean
      • Optional subscriptions?: string[]

    Returns void

sendRpc

start

stop

subscribe

unsubscribe

validate

Settings

Member Visibility

Theme

On This Page

constructor#private_registrarTopologyIdscanRelayMessagecomponentsemitSelfenabledglobalSignaturePolicylogmaxInboundStreamsmaxOutboundStreamsmulticodecspeersqueuestartedsubscriptionstopicValidatorstopics_onIncomingStream_onPeerConnected_onPeerDisconnected_removePeeracceptFromaddEventListeneraddPeerbuildMessagedecodeRpcdispatchEventencodeMessageencodeRpcgetMsgIdgetPeersgetSubscribersgetTopicsisStartedlistenerCountprocessMessageprocessMessagesprocessRpcprocessRpcSubOptpublishpublishMessageremoveEventListenersafeDispatchEventsendsendRpcstartstopsubscribeunsubscribevalidate
\ No newline at end of file +

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructor#private_registrarTopologyIdscanRelayMessagecomponentsemitSelfenabledglobalSignaturePolicylogmaxInboundStreamsmaxOutboundStreamsmulticodecspeersqueuestartedsubscriptionstopicValidatorstopics_onIncomingStream_onPeerConnected_onPeerDisconnected_removePeeracceptFromaddEventListeneraddPeerbuildMessagedecodeRpcdispatchEventencodeMessageencodeRpcgetMsgIdgetPeersgetSubscribersgetTopicsisStartedlistenerCountprocessMessageprocessMessagesprocessRpcprocessRpcSubOptpublishpublishMessageremoveEventListenersafeDispatchEventsendsendRpcstartstopsubscribeunsubscribevalidate
\ No newline at end of file diff --git a/classes/_libp2p_pubsub.peer_streams.PeerStreams.html b/classes/_libp2p_pubsub.peer_streams.PeerStreams.html index ff55a66900..26aa19dc9d 100644 --- a/classes/_libp2p_pubsub.peer_streams.PeerStreams.html +++ b/classes/_libp2p_pubsub.peer_streams.PeerStreams.html @@ -1,5 +1,5 @@ PeerStreams | libp2p

Class PeerStreams

Thin wrapper around a peer's inbound / outbound pubsub streams

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

#private _inboundAbortController _rawInboundStream? @@ -21,18 +21,18 @@ removeEventListener safeDispatchEvent write -

Constructors

constructor

Properties

Private #private

#private: any

Private Readonly _inboundAbortController

_inboundAbortController: AbortController

An AbortController for controlled shutdown of the inbound stream

-

Private Optional _rawInboundStream

_rawInboundStream?: Stream

The raw inbound stream, as retrieved from the callback from libp2p.handle

-

Private Optional _rawOutboundStream

_rawOutboundStream?: Stream

The raw outbound stream, as retrieved from conn.newStream

-

Private closed

closed: boolean

Readonly id

id: PeerId

Optional inboundStream

inboundStream?: AsyncIterable<Uint8ArrayList>

Read stream

-

Private Readonly log

log: Logger

Optional outboundStream

outboundStream?: Pushable<Uint8ArrayList, void, unknown>

Write stream - it's preferable to use the write method

-

Readonly protocol

protocol: string

Accessors

isReadable

isWritable

Methods

addEventListener

attachInboundStream

attachOutboundStream

close

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    +

Constructors

constructor

Properties

Private #private

#private: any

Private Readonly _inboundAbortController

_inboundAbortController: AbortController

An AbortController for controlled shutdown of the inbound stream

+

Private Optional _rawInboundStream

_rawInboundStream?: Stream

The raw inbound stream, as retrieved from the callback from libp2p.handle

+

Private Optional _rawOutboundStream

_rawOutboundStream?: Stream

The raw outbound stream, as retrieved from conn.newStream

+

Private closed

closed: boolean

Readonly id

id: PeerId

Optional inboundStream

inboundStream?: AsyncIterable<Uint8ArrayList>

Read stream

+

Private Readonly log

log: Logger

Optional outboundStream

outboundStream?: Pushable<Uint8ArrayList, void, unknown>

Write stream - it's preferable to use the write method

+

Readonly protocol

protocol: string

Accessors

isReadable

isWritable

Methods

addEventListener

attachInboundStream

attachOutboundStream

close

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    Returns boolean

listenerCount

  • listenerCount(type): number

  • Parameters

    • type: string

    Returns number

removeEventListener

safeDispatchEvent

write

Settings

Member Visibility

Theme

On This Page

constructor#private_inboundAbortController_rawInboundStream_rawOutboundStreamclosedidinboundStreamlogoutboundStreamprotocolisReadableisWritableaddEventListenerattachInboundStreamattachOutboundStreamclosedispatchEventlistenerCountremoveEventListenersafeDispatchEventwrite
\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

constructor#private_inboundAbortController_rawInboundStream_rawOutboundStreamclosedidinboundStreamlogoutboundStreamprotocolisReadableisWritableaddEventListenerattachInboundStreamattachOutboundStreamclosedispatchEventlistenerCountremoveEventListenersafeDispatchEventwrite
\ No newline at end of file diff --git a/classes/_libp2p_record.Libp2pRecord.html b/classes/_libp2p_record.Libp2pRecord.html index e883f7fdf4..0e9538032d 100644 --- a/classes/_libp2p_record.Libp2pRecord.html +++ b/classes/_libp2p_record.Libp2pRecord.html @@ -1,4 +1,4 @@ -Libp2pRecord | libp2p

Class Libp2pRecord

Constructors

constructor +Libp2pRecord | libp2p

Class Libp2pRecord

Constructors

constructor

Properties

key timeReceived value @@ -6,7 +6,7 @@ serialize deserialize fromDeserialized -

Constructors

constructor

Properties

key

key: Uint8Array

timeReceived

timeReceived: Date

value

value: Uint8Array

Methods

prepareSerialize

  • prepareSerialize(): Record

  • Return the object format ready to be given to the protobuf library.

    -

    Returns Record

serialize

Static deserialize

Static fromDeserialized

Settings

Member Visibility

Theme

On This Page

constructorkeytimeReceivedvalueprepareSerializeserializedeserializefromDeserialized
\ No newline at end of file +

Constructors

constructor

Properties

key

key: Uint8Array

timeReceived

timeReceived: Date

value

value: Uint8Array

Methods

prepareSerialize

  • prepareSerialize(): Record

  • Return the object format ready to be given to the protobuf library.

    +

    Returns Record

serialize

Static deserialize

Static fromDeserialized

Settings

Member Visibility

Theme

On This Page

constructorkeytimeReceivedvalueprepareSerializeserializedeserializefromDeserialized
\ No newline at end of file diff --git a/classes/_libp2p_utils.abstract_stream.AbstractStream.html b/classes/_libp2p_utils.abstract_stream.AbstractStream.html index 700b87b174..25baa45352 100644 --- a/classes/_libp2p_utils.abstract_stream.AbstractStream.html +++ b/classes/_libp2p_utils.abstract_stream.AbstractStream.html @@ -2,7 +2,7 @@ can be written to and read from at both ends.

It may be encrypted and multiplexed depending on the configuration of the nodes.

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

closed direction endErr @@ -46,44 +46,44 @@ sink sourcePush sourceReadableLength -

Constructors

constructor

Properties

Private Readonly closed

closed: DeferredPromise<void>

direction

direction: Direction

Outbound streams are opened by the local node, inbound streams are opened by the remote

-

Private endErr

endErr: undefined | Error

id

id: string

Unique identifier for a stream. Identifiers are not unique across muxers.

-

Readonly log

log: Logger

The stream logger

-

metadata

metadata: Record<string, unknown>

User defined stream metadata

-

Private Optional Readonly onAbort

onAbort?: ((err) => void)

Type declaration

    • (err): void

    • Parameters

      Returns void

Private Optional Readonly onCloseRead

onCloseRead?: (() => void)

Type declaration

    • (): void

    • Returns void

Private Optional Readonly onCloseWrite

onCloseWrite?: (() => void)

Type declaration

    • (): void

    • Returns void

Private Optional Readonly onEnd

onEnd?: ((err?) => void)

Type declaration

    • (err?): void

    • Parameters

      Returns void

Private Optional Readonly onReset

onReset?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional protocol

protocol?: string

The protocol negotiated for this stream

-

readStatus

readStatus: ReadStatus

The current status of the readable end of the stream

-

Private Readonly sendCloseWriteTimeout

sendCloseWriteTimeout: number

Private Optional sendingData

sendingData?: DeferredPromise<void>

Private Readonly sinkController

sinkController: AbortController

Private Readonly sinkEnd

sinkEnd: DeferredPromise<void>

source

source: AsyncGenerator<Uint8ArrayList, void, unknown>

status

status: StreamStatus

The current status of the stream

-

Private Readonly streamSource

streamSource: Pushable<Uint8ArrayList, void, unknown>

timeline

timeline: StreamTimeline

Lifecycle times for the stream

-

writeStatus

writeStatus: WriteStatus

The current status of the writable end of the stream

-

Methods

_closeSink

_closeSinkAndSource

_closeSource

abort

  • abort(err): void

  • Close immediately for reading and writing and send a reset message (local +

Constructors

constructor

Properties

Private Readonly closed

closed: DeferredPromise<void>

direction

direction: Direction

Outbound streams are opened by the local node, inbound streams are opened by the remote

+

Private endErr

endErr: undefined | Error

id

id: string

Unique identifier for a stream. Identifiers are not unique across muxers.

+

Readonly log

log: Logger

The stream logger

+

metadata

metadata: Record<string, unknown>

User defined stream metadata

+

Private Optional Readonly onAbort

onAbort?: ((err) => void)

Type declaration

    • (err): void

    • Parameters

      Returns void

Private Optional Readonly onCloseRead

onCloseRead?: (() => void)

Type declaration

    • (): void

    • Returns void

Private Optional Readonly onCloseWrite

onCloseWrite?: (() => void)

Type declaration

    • (): void

    • Returns void

Private Optional Readonly onEnd

onEnd?: ((err?) => void)

Type declaration

    • (err?): void

    • Parameters

      Returns void

Private Optional Readonly onReset

onReset?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional protocol

protocol?: string

The protocol negotiated for this stream

+

readStatus

readStatus: ReadStatus

The current status of the readable end of the stream

+

Private Readonly sendCloseWriteTimeout

sendCloseWriteTimeout: number

Private Optional sendingData

sendingData?: DeferredPromise<void>

Private Readonly sinkController

sinkController: AbortController

Private Readonly sinkEnd

sinkEnd: DeferredPromise<void>

source

source: AsyncGenerator<Uint8ArrayList, void, unknown>

status

status: StreamStatus

The current status of the stream

+

Private Readonly streamSource

streamSource: Pushable<Uint8ArrayList, void, unknown>

timeline

timeline: StreamTimeline

Lifecycle times for the stream

+

writeStatus

writeStatus: WriteStatus

The current status of the writable end of the stream

+

Methods

_closeSink

_closeSinkAndSource

_closeSource

abort

close

close

closeRead

closeRead

closeWrite

closeWrite

destroy

destroy

Protected onSinkEnd

Protected onSourceEnd

remoteCloseRead

Protected onSinkEnd

Protected onSourceEnd

remoteCloseRead

remoteCloseWrite

remoteCloseWrite

reset

reset

Abstract sendCloseRead

Abstract sendCloseRead

Abstract sendCloseWrite

Abstract sendCloseWrite

Abstract sendData

Abstract sendNewStream

Abstract sendData

Abstract sendNewStream

Abstract sendReset

sink

sourcePush

Abstract sendReset

sink

sourcePush

sourceReadableLength

sourceReadableLength

Settings

Member Visibility

Theme

On This Page

constructorcloseddirectionendErridlogmetadataonAbortonCloseReadonCloseWriteonEndonResetprotocolreadStatussendCloseWriteTimeoutsendingDatasinkControllersinkEndsourcestatusstreamSourcetimelinewriteStatus_closeSink_closeSinkAndSource_closeSourceabortclosecloseReadcloseWritedestroyonSinkEndonSourceEndremoteCloseReadremoteCloseWriteresetsendCloseReadsendCloseWritesendDatasendNewStreamsendResetsinksourcePushsourceReadableLength
\ No newline at end of file +

Returns number

Settings

Member Visibility

Theme

On This Page

constructorcloseddirectionendErridlogmetadataonAbortonCloseReadonCloseWriteonEndonResetprotocolreadStatussendCloseWriteTimeoutsendingDatasinkControllersinkEndsourcestatusstreamSourcetimelinewriteStatus_closeSink_closeSinkAndSource_closeSourceabortclosecloseReadcloseWritedestroyonSinkEndonSourceEndremoteCloseReadremoteCloseWriteresetsendCloseReadsendCloseWritesendDatasendNewStreamsendResetsinksourcePushsourceReadableLength
\ No newline at end of file diff --git a/classes/_libp2p_utils.adaptive_timeout.AdaptiveTimeout.html b/classes/_libp2p_utils.adaptive_timeout.AdaptiveTimeout.html index 5ea750a697..d9c3460de4 100644 --- a/classes/_libp2p_utils.adaptive_timeout.AdaptiveTimeout.html +++ b/classes/_libp2p_utils.adaptive_timeout.AdaptiveTimeout.html @@ -1,4 +1,4 @@ -AdaptiveTimeout | libp2p

Class AdaptiveTimeout

Constructors

constructor +AdaptiveTimeout | libp2p

Class AdaptiveTimeout

Constructors

constructor

Properties

failure failureMultiplier metric? @@ -8,4 +8,4 @@ timeoutMultiplier

Methods

cleanUp getTimeoutSignal -

Constructors

constructor

Properties

Private Readonly failure

failure: MovingAverage

Private Readonly failureMultiplier

failureMultiplier: number

Private Optional Readonly metric

metric?: MetricGroup<any>

Private Readonly minTimeout

minTimeout: number

Private Readonly next

next: MovingAverage

Private Readonly success

success: MovingAverage

Private Readonly timeoutMultiplier

timeoutMultiplier: number

Methods

cleanUp

getTimeoutSignal

Settings

Member Visibility

Theme

On This Page

constructorfailurefailureMultipliermetricminTimeoutnextsuccesstimeoutMultipliercleanUpgetTimeoutSignal
\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly failure

failure: MovingAverage

Private Readonly failureMultiplier

failureMultiplier: number

Private Optional Readonly metric

metric?: MetricGroup<any>

Private Readonly minTimeout

minTimeout: number

Private Readonly next

next: MovingAverage

Private Readonly success

success: MovingAverage

Private Readonly timeoutMultiplier

timeoutMultiplier: number

Methods

cleanUp

getTimeoutSignal

Settings

Member Visibility

Theme

On This Page

constructorfailurefailureMultipliermetricminTimeoutnextsuccesstimeoutMultipliercleanUpgetTimeoutSignal
\ No newline at end of file diff --git a/classes/_libp2p_utils.filters.BloomFilter.html b/classes/_libp2p_utils.filters.BloomFilter.html index aed26f0b4d..adba83c416 100644 --- a/classes/_libp2p_utils.filters.BloomFilter.html +++ b/classes/_libp2p_utils.filters.BloomFilter.html @@ -1,4 +1,4 @@ -BloomFilter | libp2p

Class BloomFilter

Implements

Constructors

constructor +BloomFilter | libp2p

Class BloomFilter

Implements

Constructors

constructor

Properties

bits buffer seeds @@ -7,9 +7,9 @@ getbit has setbit -

Constructors

constructor

Properties

Readonly bits

bits: number

buffer

buffer: Uint8Array

Readonly seeds

seeds: number[]

Methods

add

clear

getbit

has

  • has(item): boolean

  • Test if the filter has an item. If it returns false it definitely does not +

Constructors

constructor

Properties

Readonly bits

bits: number

buffer

buffer: Uint8Array

Readonly seeds

seeds: number[]

Methods

add

clear

getbit

has

  • has(item): boolean

  • Test if the filter has an item. If it returns false it definitely does not have the item. If it returns true, it probably has the item but there's an errorRate chance it doesn't.

    -

    Parameters

    Returns boolean

setbit

Settings

Member Visibility

Theme

On This Page

constructorbitsbufferseedsaddcleargetbithassetbit
\ No newline at end of file +

Parameters

Returns boolean

setbit

Settings

Member Visibility

Theme

On This Page

constructorbitsbufferseedsaddcleargetbithassetbit
\ No newline at end of file diff --git a/classes/_libp2p_utils.filters.Bucket.html b/classes/_libp2p_utils.filters.Bucket.html index eaf6de1e1a..bed48664ec 100644 --- a/classes/_libp2p_utils.filters.Bucket.html +++ b/classes/_libp2p_utils.filters.Bucket.html @@ -1,7 +1,7 @@ -Bucket | libp2p

Class Bucket

Constructors

constructor +Bucket | libp2p

Class Bucket

Constructors

constructor

Properties

contents

Methods

add has remove swap -

Constructors

constructor

Properties

Private Readonly contents

contents: (null | Fingerprint)[]

Methods

add

has

remove

swap

Settings

Member Visibility

Theme

On This Page

constructorcontentsaddhasremoveswap
\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly contents

contents: (null | Fingerprint)[]

Methods

add

has

remove

swap

Settings

Member Visibility

Theme

On This Page

constructorcontentsaddhasremoveswap
\ No newline at end of file diff --git a/classes/_libp2p_utils.filters.CuckooFilter.html b/classes/_libp2p_utils.filters.CuckooFilter.html index ab632fa4d6..afc03f609d 100644 --- a/classes/_libp2p_utils.filters.CuckooFilter.html +++ b/classes/_libp2p_utils.filters.CuckooFilter.html @@ -1,4 +1,4 @@ -CuckooFilter | libp2p

Class CuckooFilter

Implements

Constructors

constructor +CuckooFilter | libp2p

Class CuckooFilter

Implements

Constructors

constructor

Properties

bucketSize buckets count @@ -10,4 +10,4 @@

Methods

add has remove -

Constructors

constructor

Properties

Private Readonly bucketSize

bucketSize: number

Private Readonly buckets

buckets: Bucket[]

count

count: number

Private Readonly filterSize

filterSize: number

Private Readonly fingerprintSize

fingerprintSize: number

Private Readonly hash

hash: Hash

Private Readonly seed

seed: number

Accessors

reliable

Methods

add

has

remove

Settings

Member Visibility

Theme

On This Page

constructorbucketSizebucketscountfilterSizefingerprintSizehashseedreliableaddhasremove
\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly bucketSize

bucketSize: number

Private Readonly buckets

buckets: Bucket[]

count

count: number

Private Readonly filterSize

filterSize: number

Private Readonly fingerprintSize

fingerprintSize: number

Private Readonly hash

hash: Hash

Private Readonly seed

seed: number

Accessors

reliable

Methods

add

has

remove

Settings

Member Visibility

Theme

On This Page

constructorbucketSizebucketscountfilterSizefingerprintSizehashseedreliableaddhasremove
\ No newline at end of file diff --git a/classes/_libp2p_utils.filters.Fingerprint.html b/classes/_libp2p_utils.filters.Fingerprint.html index 14a3f0ee84..fd1922055a 100644 --- a/classes/_libp2p_utils.filters.Fingerprint.html +++ b/classes/_libp2p_utils.filters.Fingerprint.html @@ -1,7 +1,7 @@ -Fingerprint | libp2p

Class Fingerprint

Constructors

constructor +Fingerprint | libp2p

Class Fingerprint

Constructors

constructor

Properties

fp h seed

Methods

equals hash -

Constructors

constructor

Properties

Private Readonly fp

fp: Uint8Array

Private Readonly h

h: Hash

Private Readonly seed

seed: number

Methods

equals

hash

Settings

Member Visibility

Theme

On This Page

constructorfphseedequalshash
\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly fp

fp: Uint8Array

Private Readonly h

h: Hash

Private Readonly seed

seed: number

Methods

equals

hash

Settings

Member Visibility

Theme

On This Page

constructorfphseedequalshash
\ No newline at end of file diff --git a/classes/_libp2p_utils.filters.ScalableCuckooFilter.html b/classes/_libp2p_utils.filters.ScalableCuckooFilter.html index ddd682e100..f0a26ef57d 100644 --- a/classes/_libp2p_utils.filters.ScalableCuckooFilter.html +++ b/classes/_libp2p_utils.filters.ScalableCuckooFilter.html @@ -1,4 +1,4 @@ -ScalableCuckooFilter | libp2p

Class ScalableCuckooFilter

Implements

Constructors

constructor +ScalableCuckooFilter | libp2p

Class ScalableCuckooFilter

Implements

Constructors

constructor

Properties

bucketSize filterSeries filterSize @@ -10,4 +10,4 @@

Methods

add has remove -

Constructors

constructor

Properties

Private Readonly bucketSize

bucketSize: number

Private Readonly filterSeries

filterSeries: CuckooFilter[]

Private Readonly filterSize

filterSize: number

Private Readonly fingerprintSize

fingerprintSize: number

Private Readonly hash

hash: Hash

Private Readonly scale

scale: number

Private Readonly seed

seed: number

Accessors

count

Methods

add

has

remove

Settings

Member Visibility

Theme

On This Page

constructorbucketSizefilterSeriesfilterSizefingerprintSizehashscaleseedcountaddhasremove
\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly bucketSize

bucketSize: number

Private Readonly filterSeries

filterSeries: CuckooFilter[]

Private Readonly filterSize

filterSize: number

Private Readonly fingerprintSize

fingerprintSize: number

Private Readonly hash

hash: Hash

Private Readonly scale

scale: number

Private Readonly seed

seed: number

Accessors

count

Methods

add

has

remove

Settings

Member Visibility

Theme

On This Page

constructorbucketSizefilterSeriesfilterSizefingerprintSizehashscaleseedcountaddhasremove
\ No newline at end of file diff --git a/classes/_libp2p_utils.moving_average.MovingAverage.html b/classes/_libp2p_utils.moving_average.MovingAverage.html index f45eeee179..2134e0e73a 100644 --- a/classes/_libp2p_utils.moving_average.MovingAverage.html +++ b/classes/_libp2p_utils.moving_average.MovingAverage.html @@ -3,7 +3,7 @@
  • https://en.wikipedia.org/wiki/Moving_average#Exponential_moving_average
  • https://www.npmjs.com/package/moving-average
    • -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    deviation forecast movingAverage @@ -12,4 +12,4 @@ variance

    Methods

    alpha push -

    Constructors

    constructor

    Properties

    deviation

    deviation: number

    forecast

    forecast: number

    movingAverage

    movingAverage: number

    Private Optional previousTime

    previousTime?: number

    Private Readonly timespan

    timespan: number

    variance

    variance: number

    Methods

    alpha

    push

    Settings

    Member Visibility

    Theme

    On This Page

    constructordeviationforecastmovingAveragepreviousTimetimespanvariancealphapush
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    deviation

    deviation: number

    forecast

    forecast: number

    movingAverage

    movingAverage: number

    Private Optional previousTime

    previousTime?: number

    Private Readonly timespan

    timespan: number

    variance

    variance: number

    Methods

    alpha

    push

    Settings

    Member Visibility

    Theme

    On This Page

    constructordeviationforecastmovingAveragepreviousTimetimespanvariancealphapush
    \ No newline at end of file diff --git a/classes/_libp2p_utils.peer_queue.PeerQueue.html b/classes/_libp2p_utils.peer_queue.PeerQueue.html index 4823e6de78..05157e6e9a 100644 --- a/classes/_libp2p_utils.peer_queue.PeerQueue.html +++ b/classes/_libp2p_utils.peer_queue.PeerQueue.html @@ -1,5 +1,5 @@ PeerQueue | libp2p

    Class PeerQueue<JobReturnType, JobOptions>

    Extends Queue to add support for querying queued jobs by peer id

    -

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    #private concurrency maxSize @@ -21,32 +21,32 @@ removeEventListener safeDispatchEvent toGenerator -

    Constructors

    constructor

    Properties

    Private #private

    #private: any

    concurrency

    concurrency: number

    maxSize

    maxSize: number

    queue

    queue: Job<JobOptions, JobReturnType>[]

    Accessors

    queued

    running

    size

    Methods

    abort

    add

    addEventListener

    clear

    dispatchEvent

    • dispatchEvent(event): boolean

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      +

    Constructors

    constructor

    Properties

    Private #private

    #private: any

    concurrency

    concurrency: number

    maxSize

    maxSize: number

    queue

    queue: Job<JobOptions, JobReturnType>[]

    Accessors

    queued

    running

    size

    Methods

    abort

    add

    addEventListener

    clear

    dispatchEvent

    • dispatchEvent(event): boolean

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      MDN Reference

      -

      Parameters

      Returns boolean

    find

    has

    listenerCount

    • listenerCount(type): number

    • Parameters

      • type: string

      Returns number

    onEmpty

    • onEmpty(options?): Promise<void>

    • Can be called multiple times. Useful if you for example add additional items at a later time.

      +

      Parameters

      Returns boolean

    find

    has

    listenerCount

    • listenerCount(type): number

    • Parameters

      • type: string

      Returns number

    onEmpty

    onIdle

    onIdle

    • onIdle(options?): Promise<void>

    • The difference with .onEmpty is that .onIdle guarantees that all work from the queue has finished. .onEmpty merely signals that the queue is empty, but it could mean that some promises haven't completed yet.

      Parameters

      Returns Promise<void>

      A promise that settles when the queue becomes empty, and all promises have completed; queue.size === 0 && queue.pending === 0.

      -

    onSizeLessThan

    onSizeLessThan

    • onSizeLessThan(limit, options?): Promise<void>

    • Parameters

      Returns Promise<void>

      A promise that settles when the queue size is less than the given limit: queue.size < limit.

      If you want to avoid having the queue grow beyond a certain size you can await queue.onSizeLessThan() before adding a new item.

      Note that this only limits the number of items waiting to start. There could still be up to concurrency jobs already running that this call does not include in its calculation.

      -

    removeEventListener

    safeDispatchEvent

    toGenerator

    removeEventListener

    safeDispatchEvent

    toGenerator

    Settings

    Member Visibility

    Theme

    On This Page

    constructor#privateconcurrencymaxSizequeuequeuedrunningsizeabortaddaddEventListenercleardispatchEventfindhaslistenerCountonEmptyonIdleonSizeLessThanremoveEventListenersafeDispatchEventtoGenerator
    \ No newline at end of file +

    Parameters

    Returns AsyncGenerator<JobReturnType, void, unknown>

    Settings

    Member Visibility

    Theme

    On This Page

    constructor#privateconcurrencymaxSizequeuequeuedrunningsizeabortaddaddEventListenercleardispatchEventfindhaslistenerCountonEmptyonIdleonSizeLessThanremoveEventListenersafeDispatchEventtoGenerator
    \ No newline at end of file diff --git a/classes/_libp2p_utils.priority_queue.PriorityQueue.html b/classes/_libp2p_utils.priority_queue.PriorityQueue.html index 428efa1ef9..c9135e5583 100644 --- a/classes/_libp2p_utils.priority_queue.PriorityQueue.html +++ b/classes/_libp2p_utils.priority_queue.PriorityQueue.html @@ -3,7 +3,7 @@
  • Items remain at the head of the queue while they are running so queue.size includes queue.pending items - this is so interested parties can join the results of a queue item while it is running
  • The options for a job are stored separately to the job in order for them to be modified while they are still in the queue
    • -

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    #private concurrency maxSize @@ -23,32 +23,32 @@ removeEventListener safeDispatchEvent toGenerator -

    Constructors

    constructor

    Properties

    Private #private

    #private: any

    concurrency

    concurrency: number

    maxSize

    maxSize: number

    queue

    queue: Job<JobOptions, JobReturnType>[]

    Accessors

    queued

    running

    size

    Methods

    abort

    add

    addEventListener

    clear

    dispatchEvent

    • dispatchEvent(event): boolean

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      +

    Constructors

    constructor

    Properties

    Private #private

    #private: any

    concurrency

    concurrency: number

    maxSize

    maxSize: number

    queue

    queue: Job<JobOptions, JobReturnType>[]

    Accessors

    queued

    running

    size

    Methods

    abort

    add

    addEventListener

    clear

    dispatchEvent

    listenerCount

    onEmpty

    onIdle

    onIdle

    onSizeLessThan

    onSizeLessThan

    removeEventListener

    safeDispatchEvent

    toGenerator

    removeEventListener

    safeDispatchEvent

    toGenerator

    Settings

    Member Visibility

    Theme

    On This Page

    constructor#privateconcurrencymaxSizequeuequeuedrunningsizeabortaddaddEventListenercleardispatchEventlistenerCountonEmptyonIdleonSizeLessThanremoveEventListenersafeDispatchEventtoGenerator
    \ No newline at end of file +

    Parameters

    Returns AsyncGenerator<JobReturnType, void, unknown>

    Settings

    Member Visibility

    Theme

    On This Page

    constructor#privateconcurrencymaxSizequeuequeuedrunningsizeabortaddaddEventListenercleardispatchEventlistenerCountonEmptyonIdleonSizeLessThanremoveEventListenersafeDispatchEventtoGenerator
    \ No newline at end of file diff --git a/classes/_libp2p_utils.queue.Job.html b/classes/_libp2p_utils.queue.Job.html index 5d900637a1..17cf0015bc 100644 --- a/classes/_libp2p_utils.queue.Job.html +++ b/classes/_libp2p_utils.queue.Job.html @@ -1,4 +1,4 @@ -Job | libp2p

    Class Job<JobOptions, JobReturnType>

    Type Parameters

    Constructors

    constructor +Job | libp2p

    Class Job<JobOptions, JobReturnType>

    Type Parameters

    Constructors

    constructor

    Properties

    controller fn id @@ -11,4 +11,4 @@ join onAbort run -

    Constructors

    constructor

    Properties

    Private Readonly controller

    controller: AbortController

    fn

    fn: ((options) => Promise<JobReturnType>)

    Type declaration

    id

    id: string

    options

    options: JobOptions

    recipients

    recipients: JobRecipient<JobReturnType>[]

    status

    status: JobStatus

    Readonly timeline

    timeline: JobTimeline

    Methods

    abort

    cleanup

    join

    onAbort

    run

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcontrollerfnidoptionsrecipientsstatustimelineabortcleanupjoinonAbortrun
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Readonly controller

    controller: AbortController

    fn

    fn: ((options) => Promise<JobReturnType>)

    Type declaration

    id

    id: string

    options

    options: JobOptions

    recipients

    recipients: JobRecipient<JobReturnType>[]

    status

    status: JobStatus

    Readonly timeline

    timeline: JobTimeline

    Methods

    abort

    cleanup

    join

    onAbort

    run

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcontrollerfnidoptionsrecipientsstatustimelineabortcleanupjoinonAbortrun
    \ No newline at end of file diff --git a/classes/_libp2p_utils.queue.JobRecipient.html b/classes/_libp2p_utils.queue.JobRecipient.html index 7e18a335ad..7b639e8a6d 100644 --- a/classes/_libp2p_utils.queue.JobRecipient.html +++ b/classes/_libp2p_utils.queue.JobRecipient.html @@ -1,6 +1,6 @@ -JobRecipient | libp2p

    Class JobRecipient<JobReturnType>

    Type Parameters

    • JobReturnType

    Constructors

    constructor +JobRecipient | libp2p

    Class JobRecipient<JobReturnType>

    Type Parameters

    • JobReturnType

    Constructors

    constructor

    Properties

    deferred signal?

    Methods

    cleanup onAbort -

    Constructors

    constructor

    Properties

    deferred

    deferred: DeferredPromise<JobReturnType>

    Optional signal

    signal?: AbortSignal

    Methods

    cleanup

    onAbort

    Settings

    Member Visibility

    Theme

    On This Page

    constructordeferredsignalcleanuponAbort
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    deferred

    deferred: DeferredPromise<JobReturnType>

    Optional signal

    signal?: AbortSignal

    Methods

    cleanup

    onAbort

    Settings

    Member Visibility

    Theme

    On This Page

    constructordeferredsignalcleanuponAbort
    \ No newline at end of file diff --git a/classes/_libp2p_utils.queue.Queue.html b/classes/_libp2p_utils.queue.Queue.html index 7f77b63d04..7cc8a206a1 100644 --- a/classes/_libp2p_utils.queue.Queue.html +++ b/classes/_libp2p_utils.queue.Queue.html @@ -3,7 +3,7 @@
  • Items remain at the head of the queue while they are running so queue.size includes queue.pending items - this is so interested parties can join the results of a queue item while it is running
  • The options for a job are stored separately to the job in order for them to be modified while they are still in the queue
    • -

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    #private concurrency maxSize @@ -27,32 +27,32 @@ safeDispatchEvent toGenerator tryToStartAnother -

    Constructors

    constructor

    Properties

    Private #private

    #private: any

    concurrency

    concurrency: number

    maxSize

    maxSize: number

    Private pending

    pending: number

    queue

    queue: Job<JobOptions, JobReturnType>[]

    Private Optional Readonly sort

    sort?: Comparator<Job<JobOptions, JobReturnType>>

    Accessors

    queued

    running

    size

    Methods

    abort

    add

    addEventListener

    clear

    dispatchEvent

    • dispatchEvent(event): boolean

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      +

    Constructors

    constructor

    Properties

    Private #private

    #private: any

    concurrency

    concurrency: number

    maxSize

    maxSize: number

    Private pending

    pending: number

    queue

    queue: Job<JobOptions, JobReturnType>[]

    Private Optional Readonly sort

    sort?: Comparator<Job<JobOptions, JobReturnType>>

    Accessors

    queued

    running

    size

    Methods

    abort

    add

    addEventListener

    clear

    dispatchEvent

    Private enqueue

    listenerCount

    onEmpty

    Private enqueue

    listenerCount

    onEmpty

    onIdle

    onIdle

    onSizeLessThan

    onSizeLessThan

    removeEventListener

    safeDispatchEvent

    toGenerator

    removeEventListener

    safeDispatchEvent

    toGenerator

    Private tryToStartAnother

    Settings

    Member Visibility

    Theme

    On This Page

    constructor#privateconcurrencymaxSizependingqueuesortqueuedrunningsizeabortaddaddEventListenercleardispatchEventenqueuelistenerCountonEmptyonIdleonSizeLessThanremoveEventListenersafeDispatchEventtoGeneratortryToStartAnother
    \ No newline at end of file +

    Parameters

    Returns AsyncGenerator<JobReturnType, void, unknown>

    Private tryToStartAnother

    Settings

    Member Visibility

    Theme

    On This Page

    constructor#privateconcurrencymaxSizependingqueuesortqueuedrunningsizeabortaddaddEventListenercleardispatchEventenqueuelistenerCountonEmptyonIdleonSizeLessThanremoveEventListenersafeDispatchEventtoGeneratortryToStartAnother
    \ No newline at end of file diff --git a/classes/_libp2p_utils.rate_limiter.MemoryStorage.html b/classes/_libp2p_utils.rate_limiter.MemoryStorage.html index 561ca12aeb..8fef0d05d8 100644 --- a/classes/_libp2p_utils.rate_limiter.MemoryStorage.html +++ b/classes/_libp2p_utils.rate_limiter.MemoryStorage.html @@ -1,7 +1,7 @@ -MemoryStorage | libp2p

    Class MemoryStorage

    Constructors

    constructor +MemoryStorage | libp2p

    Class MemoryStorage

    Constructors

    constructor

    Properties

    storage

    Methods

    delete get incrby set -

    Constructors

    constructor

    Properties

    Readonly storage

    storage: Map<string, RateRecord>

    Methods

    delete

    get

    incrby

    set

    Settings

    Member Visibility

    Theme

    On This Page

    constructorstoragedeletegetincrbyset
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly storage

    storage: Map<string, RateRecord>

    Methods

    delete

    get

    incrby

    set

    Settings

    Member Visibility

    Theme

    On This Page

    constructorstoragedeletegetincrbyset
    \ No newline at end of file diff --git a/classes/_libp2p_utils.rate_limiter.RateLimiter.html b/classes/_libp2p_utils.rate_limiter.RateLimiter.html index 3fe6ac3702..c179b60f2e 100644 --- a/classes/_libp2p_utils.rate_limiter.RateLimiter.html +++ b/classes/_libp2p_utils.rate_limiter.RateLimiter.html @@ -1,4 +1,4 @@ -RateLimiter | libp2p

    Class RateLimiter

    Constructors

    constructor +RateLimiter | libp2p

    Class RateLimiter

    Constructors

    constructor

    Properties

    blockDuration duration execEvenly @@ -16,5 +16,5 @@ penalty reward set -

    Constructors

    constructor

    Properties

    Protected blockDuration

    blockDuration: number

    Protected duration

    duration: number

    Protected execEvenly

    execEvenly: boolean

    Protected execEvenlyMinDelayMs

    execEvenlyMinDelayMs: number

    Protected keyPrefix

    keyPrefix: string

    Readonly memoryStorage

    memoryStorage: MemoryStorage

    Protected points

    points: number

    Methods

    Private _getKeySecDuration

    block

    consume

    delete

    get

    getKey

    parseKey

    penalty

    reward

    set

    Settings

    Member Visibility

    Theme

    On This Page

    constructorblockDurationdurationexecEvenlyexecEvenlyMinDelayMskeyPrefixmemoryStoragepoints_getKeySecDurationblockconsumedeletegetgetKeyparseKeypenaltyrewardset
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Protected blockDuration

    blockDuration: number

    Protected duration

    duration: number

    Protected execEvenly

    execEvenly: boolean

    Protected execEvenlyMinDelayMs

    execEvenlyMinDelayMs: number

    Protected keyPrefix

    keyPrefix: string

    Readonly memoryStorage

    memoryStorage: MemoryStorage

    Protected points

    points: number

    Methods

    Private _getKeySecDuration

    block

    consume

    delete

    get

    getKey

    parseKey

    penalty

    reward

    set

    Settings

    Member Visibility

    Theme

    On This Page

    constructorblockDurationdurationexecEvenlyexecEvenlyMinDelayMskeyPrefixmemoryStoragepoints_getKeySecDurationblockconsumedeletegetgetKeyparseKeypenaltyrewardset
    \ No newline at end of file diff --git a/enums/_libp2p_interface.FaultTolerance.html b/enums/_libp2p_interface.FaultTolerance.html index 120990d54a..156fb109e6 100644 --- a/enums/_libp2p_interface.FaultTolerance.html +++ b/enums/_libp2p_interface.FaultTolerance.html @@ -1,6 +1,6 @@ FaultTolerance | libp2p

    Enumeration FaultTolerance

    Enum Transport Manager Fault Tolerance values

    -

    Enumeration Members

    FATAL_ALL +

    Enumeration Members

    FATAL_ALL NO_FATAL

    Enumeration Members

    FATAL_ALL

    FATAL_ALL: 0

    should be used for failing in any listen circumstance

    -

    NO_FATAL

    NO_FATAL: 1

    should be used for not failing when not listening

    -

    Settings

    Member Visibility

    Theme

    On This Page

    FATAL_ALLNO_FATAL
    \ No newline at end of file +

    NO_FATAL

    NO_FATAL: 1

    should be used for not failing when not listening

    +

    Settings

    Member Visibility

    Theme

    On This Page

    FATAL_ALLNO_FATAL
    \ No newline at end of file diff --git a/enums/_libp2p_interface.TopicValidatorResult.html b/enums/_libp2p_interface.TopicValidatorResult.html index af761be26b..1c3179f466 100644 --- a/enums/_libp2p_interface.TopicValidatorResult.html +++ b/enums/_libp2p_interface.TopicValidatorResult.html @@ -1,7 +1,7 @@ -TopicValidatorResult | libp2p

    Enumeration TopicValidatorResult

    Enumeration Members

    Accept +TopicValidatorResult | libp2p

    Enumeration TopicValidatorResult

    Enumeration Members

    Accept Ignore Reject

    Enumeration Members

    Accept

    Accept: "accept"

    The message is considered valid, and it should be delivered and forwarded to the network

    -

    Ignore

    Ignore: "ignore"

    The message is neither delivered nor forwarded to the network

    -

    Reject

    Reject: "reject"

    The message is considered invalid, and it should be rejected

    -

    Settings

    Member Visibility

    Theme

    On This Page

    AcceptIgnoreReject
    \ No newline at end of file +

    Ignore

    Ignore: "ignore"

    The message is neither delivered nor forwarded to the network

    +

    Reject

    Reject: "reject"

    The message is considered invalid, and it should be rejected

    +

    Settings

    Member Visibility

    Theme

    On This Page

    AcceptIgnoreReject
    \ No newline at end of file diff --git a/enums/_libp2p_kad_dht.EventTypes.html b/enums/_libp2p_kad_dht.EventTypes.html index 72df54d6e7..55e1f3b02a 100644 --- a/enums/_libp2p_kad_dht.EventTypes.html +++ b/enums/_libp2p_kad_dht.EventTypes.html @@ -1,5 +1,5 @@ EventTypes | libp2p

    Enumeration EventTypes

    The types of events emitted during DHT queries

    -

    Enumeration Members

    ADD_PEER +

    Enumeration Members

    ADD_PEER DIAL_PEER FINAL_PEER PEER_RESPONSE @@ -7,4 +7,4 @@ QUERY_ERROR SEND_QUERY VALUE -

    Enumeration Members

    ADD_PEER

    ADD_PEER: 6

    DIAL_PEER

    DIAL_PEER: 7

    FINAL_PEER

    FINAL_PEER: 2

    PEER_RESPONSE

    PEER_RESPONSE: 1

    PROVIDER

    PROVIDER: 4

    QUERY_ERROR

    QUERY_ERROR: 3

    SEND_QUERY

    SEND_QUERY: 0

    VALUE

    VALUE: 5

    Settings

    Member Visibility

    Theme

    On This Page

    ADD_PEERDIAL_PEERFINAL_PEERPEER_RESPONSEPROVIDERQUERY_ERRORSEND_QUERYVALUE
    \ No newline at end of file +

    Enumeration Members

    ADD_PEER

    ADD_PEER: 6

    DIAL_PEER

    DIAL_PEER: 7

    FINAL_PEER

    FINAL_PEER: 2

    PEER_RESPONSE

    PEER_RESPONSE: 1

    PROVIDER

    PROVIDER: 4

    QUERY_ERROR

    QUERY_ERROR: 3

    SEND_QUERY

    SEND_QUERY: 0

    VALUE

    VALUE: 5

    Settings

    Member Visibility

    Theme

    On This Page

    ADD_PEERDIAL_PEERFINAL_PEERPEER_RESPONSEPROVIDERQUERY_ERRORSEND_QUERYVALUE
    \ No newline at end of file diff --git a/enums/_libp2p_kad_dht.MessageType-1.html b/enums/_libp2p_kad_dht.MessageType-1.html index c005b7069f..74d055c32d 100644 --- a/enums/_libp2p_kad_dht.MessageType-1.html +++ b/enums/_libp2p_kad_dht.MessageType-1.html @@ -1,7 +1,7 @@ -MessageType | libp2p

    Enumeration MessageType

    Enumeration Members

    ADD_PROVIDER +MessageType | libp2p

    Enumeration MessageType

    Enumeration Members

    ADD_PROVIDER FIND_NODE GET_PROVIDERS GET_VALUE PING PUT_VALUE -

    Enumeration Members

    ADD_PROVIDER

    ADD_PROVIDER: "ADD_PROVIDER"

    FIND_NODE

    FIND_NODE: "FIND_NODE"

    GET_PROVIDERS

    GET_PROVIDERS: "GET_PROVIDERS"

    GET_VALUE

    GET_VALUE: "GET_VALUE"

    PING

    PING: "PING"

    PUT_VALUE

    PUT_VALUE: "PUT_VALUE"

    Settings

    Member Visibility

    Theme

    On This Page

    ADD_PROVIDERFIND_NODEGET_PROVIDERSGET_VALUEPINGPUT_VALUE
    \ No newline at end of file +

    Enumeration Members

    ADD_PROVIDER

    ADD_PROVIDER: "ADD_PROVIDER"

    FIND_NODE

    FIND_NODE: "FIND_NODE"

    GET_PROVIDERS

    GET_PROVIDERS: "GET_PROVIDERS"

    GET_VALUE

    GET_VALUE: "GET_VALUE"

    PING

    PING: "PING"

    PUT_VALUE

    PUT_VALUE: "PUT_VALUE"

    Settings

    Member Visibility

    Theme

    On This Page

    ADD_PROVIDERFIND_NODEGET_PROVIDERSGET_VALUEPINGPUT_VALUE
    \ No newline at end of file diff --git a/functions/_libp2p_auto_tls.autoTLS-1.html b/functions/_libp2p_auto_tls.autoTLS-1.html index de5e7b4921..a71b02f482 100644 --- a/functions/_libp2p_auto_tls.autoTLS-1.html +++ b/functions/_libp2p_auto_tls.autoTLS-1.html @@ -1 +1 @@ -autoTLS | libp2p

    Function autoTLS

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +autoTLS | libp2p

    Function autoTLS

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_autonat.autoNAT.html b/functions/_libp2p_autonat.autoNAT.html index d2bd2ce7ae..019d352dab 100644 --- a/functions/_libp2p_autonat.autoNAT.html +++ b/functions/_libp2p_autonat.autoNAT.html @@ -1 +1 @@ -autoNAT | libp2p

    Function autoNAT

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +autoNAT | libp2p

    Function autoNAT

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_bootstrap.bootstrap.html b/functions/_libp2p_bootstrap.bootstrap.html index 9ed181bc9c..df8085efce 100644 --- a/functions/_libp2p_bootstrap.bootstrap.html +++ b/functions/_libp2p_bootstrap.bootstrap.html @@ -1 +1 @@ -bootstrap | libp2p

    Function bootstrap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +bootstrap | libp2p

    Function bootstrap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_circuit_relay_v2.Limit.codec.html b/functions/_libp2p_circuit_relay_v2.Limit.codec.html index 0fdd759e00..bfed890760 100644 --- a/functions/_libp2p_circuit_relay_v2.Limit.codec.html +++ b/functions/_libp2p_circuit_relay_v2.Limit.codec.html @@ -1 +1 @@ -codec | libp2p

    Function codec

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +codec | libp2p

    Function codec

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_circuit_relay_v2.Limit.decode.html b/functions/_libp2p_circuit_relay_v2.Limit.decode.html index 09410cb3e0..1d2e456711 100644 --- a/functions/_libp2p_circuit_relay_v2.Limit.decode.html +++ b/functions/_libp2p_circuit_relay_v2.Limit.decode.html @@ -1 +1 @@ -decode | libp2p

    Function decode

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +decode | libp2p

    Function decode

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_circuit_relay_v2.Limit.encode.html b/functions/_libp2p_circuit_relay_v2.Limit.encode.html index 6bfaf8443b..2105e0899b 100644 --- a/functions/_libp2p_circuit_relay_v2.Limit.encode.html +++ b/functions/_libp2p_circuit_relay_v2.Limit.encode.html @@ -1 +1 @@ -encode | libp2p

    Function encode

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +encode | libp2p

    Function encode

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_circuit_relay_v2.circuitRelayServer.html b/functions/_libp2p_circuit_relay_v2.circuitRelayServer.html index 966d6c9b5d..fcdf9379aa 100644 --- a/functions/_libp2p_circuit_relay_v2.circuitRelayServer.html +++ b/functions/_libp2p_circuit_relay_v2.circuitRelayServer.html @@ -1 +1 @@ -circuitRelayServer | libp2p

    Function circuitRelayServer

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +circuitRelayServer | libp2p

    Function circuitRelayServer

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_circuit_relay_v2.circuitRelayTransport.html b/functions/_libp2p_circuit_relay_v2.circuitRelayTransport.html index 1737a89f83..7867ad5775 100644 --- a/functions/_libp2p_circuit_relay_v2.circuitRelayTransport.html +++ b/functions/_libp2p_circuit_relay_v2.circuitRelayTransport.html @@ -1 +1 @@ -circuitRelayTransport | libp2p

    Function circuitRelayTransport

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +circuitRelayTransport | libp2p

    Function circuitRelayTransport

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_config.loadOrCreateSelfKey.html b/functions/_libp2p_config.loadOrCreateSelfKey.html index 986f67f4ee..aa93c9efa7 100644 --- a/functions/_libp2p_config.loadOrCreateSelfKey.html +++ b/functions/_libp2p_config.loadOrCreateSelfKey.html @@ -1 +1 @@ -loadOrCreateSelfKey | libp2p

    Function loadOrCreateSelfKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +loadOrCreateSelfKey | libp2p

    Function loadOrCreateSelfKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.ciphers.AES_GCM.create.html b/functions/_libp2p_crypto.ciphers.AES_GCM.create.html index 0dc127aa2a..c34a015f6d 100644 --- a/functions/_libp2p_crypto.ciphers.AES_GCM.create.html +++ b/functions/_libp2p_crypto.ciphers.AES_GCM.create.html @@ -1 +1 @@ -create | libp2p

    Function create

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +create | libp2p

    Function create

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.hmac.create.html b/functions/_libp2p_crypto.hmac.create.html index 5e236f312a..1a88b1abe1 100644 --- a/functions/_libp2p_crypto.hmac.create.html +++ b/functions/_libp2p_crypto.hmac.create.html @@ -1 +1 @@ -create | libp2p

    Function create

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +create | libp2p

    Function create

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.index.pbkdf2.html b/functions/_libp2p_crypto.index.pbkdf2.html index 567593e502..1fe5941ab9 100644 --- a/functions/_libp2p_crypto.index.pbkdf2.html +++ b/functions/_libp2p_crypto.index.pbkdf2.html @@ -1,2 +1,2 @@ pbkdf2 | libp2p

    Function pbkdf2

    • pbkdf2(password, salt, iterations, keySize, hash): string

    • Computes the Password-Based Key Derivation Function 2.

      -

      Parameters

      • password: string
      • salt: string | Uint8Array
      • iterations: number
      • keySize: number
      • hash: string

      Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.index.randomBytes.html b/functions/_libp2p_crypto.index.randomBytes.html index f017b5dd0c..74b0152bd5 100644 --- a/functions/_libp2p_crypto.index.randomBytes.html +++ b/functions/_libp2p_crypto.index.randomBytes.html @@ -1,2 +1,2 @@ randomBytes | libp2p

    Function randomBytes

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Uint8Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.generateEphemeralKeyPair.html b/functions/_libp2p_crypto.keys.generateEphemeralKeyPair.html index 961af66688..0fe5e8ab6d 100644 --- a/functions/_libp2p_crypto.keys.generateEphemeralKeyPair.html +++ b/functions/_libp2p_crypto.keys.generateEphemeralKeyPair.html @@ -1,3 +1,3 @@ generateEphemeralKeyPair | libp2p

    Function generateEphemeralKeyPair

    • generateEphemeralKeyPair(curve): Promise<ECDHKey>

    • Generates an ephemeral public key and returns a function that will compute the shared secret key.

      Focuses only on ECDH now, but can be made more general in the future.

      -

      Parameters

      Returns Promise<ECDHKey>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Promise<ECDHKey>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.generateKeyPair.html b/functions/_libp2p_crypto.keys.generateKeyPair.html index 8c956a16da..230b45823e 100644 --- a/functions/_libp2p_crypto.keys.generateKeyPair.html +++ b/functions/_libp2p_crypto.keys.generateKeyPair.html @@ -1,2 +1,2 @@ generateKeyPair | libp2p

    Function generateKeyPair

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Promise<Ed25519PrivateKey>

  • generateKeyPair(type): Promise<Secp256k1PrivateKey>

  • Parameters

    Returns Promise<Secp256k1PrivateKey>

  • generateKeyPair(type, bits?): Promise<RSAPrivateKey>

  • Parameters

    Returns Promise<RSAPrivateKey>

  • generateKeyPair(type, bits?): Promise<PrivateKey>

  • Parameters

    Returns Promise<PrivateKey>

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.generateKeyPairFromSeed.html b/functions/_libp2p_crypto.keys.generateKeyPairFromSeed.html index ca96199995..75d3e0cef2 100644 --- a/functions/_libp2p_crypto.keys.generateKeyPairFromSeed.html +++ b/functions/_libp2p_crypto.keys.generateKeyPairFromSeed.html @@ -1,4 +1,4 @@ generateKeyPairFromSeed | libp2p

    Function generateKeyPairFromSeed

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Promise<Ed25519PrivateKey>

  • generateKeyPairFromSeed<T>(type, seed, bits?): Promise<never>

  • Type Parameters

    Parameters

    Returns Promise<never>

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.keyStretcher.html b/functions/_libp2p_crypto.keys.keyStretcher.html index 0937031904..3cd5eb771d 100644 --- a/functions/_libp2p_crypto.keys.keyStretcher.html +++ b/functions/_libp2p_crypto.keys.keyStretcher.html @@ -1,3 +1,3 @@ keyStretcher | libp2p

    Function keyStretcher

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Promise<EnhancedKeyPair>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.privateKeyFromProtobuf.html b/functions/_libp2p_crypto.keys.privateKeyFromProtobuf.html index 57e7480544..15cd2e1b0f 100644 --- a/functions/_libp2p_crypto.keys.privateKeyFromProtobuf.html +++ b/functions/_libp2p_crypto.keys.privateKeyFromProtobuf.html @@ -1,2 +1,2 @@ privateKeyFromProtobuf | libp2p

    Function privateKeyFromProtobuf

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Ed25519PrivateKey | Secp256k1PrivateKey | RSAPrivateKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.privateKeyFromRaw.html b/functions/_libp2p_crypto.keys.privateKeyFromRaw.html index 78bcd76dc8..4dbdd3dcbe 100644 --- a/functions/_libp2p_crypto.keys.privateKeyFromRaw.html +++ b/functions/_libp2p_crypto.keys.privateKeyFromRaw.html @@ -1,4 +1,4 @@ privateKeyFromRaw | libp2p

    Function privateKeyFromRaw

    • privateKeyFromRaw(buf): PrivateKey

    • Creates a private key from the raw key bytes. For Ed25519 keys this requires the public key to be appended to the private key otherwise we can't differentiate between Ed25519 and secp256k1 keys as they are the same length.

      -

      Parameters

      Returns PrivateKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns PrivateKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.privateKeyToProtobuf.html b/functions/_libp2p_crypto.keys.privateKeyToProtobuf.html index 94f7257e87..b87faef10b 100644 --- a/functions/_libp2p_crypto.keys.privateKeyToProtobuf.html +++ b/functions/_libp2p_crypto.keys.privateKeyToProtobuf.html @@ -1,2 +1,2 @@ privateKeyToProtobuf | libp2p

    Function privateKeyToProtobuf

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Uint8Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.publicKeyFromMultihash.html b/functions/_libp2p_crypto.keys.publicKeyFromMultihash.html index 51dabb2940..e86a61ac0c 100644 --- a/functions/_libp2p_crypto.keys.publicKeyFromMultihash.html +++ b/functions/_libp2p_crypto.keys.publicKeyFromMultihash.html @@ -2,4 +2,4 @@ encoded Ed25519 or secp256k1 public key.

    RSA keys are not supported as in practice we they are not stored in identity multihashes since the hash would be very large.

    -

    Parameters

    Returns Ed25519PublicKey | Secp256k1PublicKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Ed25519PublicKey | Secp256k1PublicKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.publicKeyFromProtobuf.html b/functions/_libp2p_crypto.keys.publicKeyFromProtobuf.html index a43528a882..be94183368 100644 --- a/functions/_libp2p_crypto.keys.publicKeyFromProtobuf.html +++ b/functions/_libp2p_crypto.keys.publicKeyFromProtobuf.html @@ -1,2 +1,2 @@ publicKeyFromProtobuf | libp2p

    Function publicKeyFromProtobuf

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns PublicKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.publicKeyFromRaw.html b/functions/_libp2p_crypto.keys.publicKeyFromRaw.html index 8f73c60b5a..e642bcd9c9 100644 --- a/functions/_libp2p_crypto.keys.publicKeyFromRaw.html +++ b/functions/_libp2p_crypto.keys.publicKeyFromRaw.html @@ -1,2 +1,2 @@ publicKeyFromRaw | libp2p

    Function publicKeyFromRaw

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns PublicKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.publicKeyToProtobuf.html b/functions/_libp2p_crypto.keys.publicKeyToProtobuf.html index dca6b62125..de72f25e64 100644 --- a/functions/_libp2p_crypto.keys.publicKeyToProtobuf.html +++ b/functions/_libp2p_crypto.keys.publicKeyToProtobuf.html @@ -1,2 +1,2 @@ publicKeyToProtobuf | libp2p

    Function publicKeyToProtobuf

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Uint8Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_dcutr.dcutr.html b/functions/_libp2p_dcutr.dcutr.html index ef3290f1b0..98dee45ef3 100644 --- a/functions/_libp2p_dcutr.dcutr.html +++ b/functions/_libp2p_dcutr.dcutr.html @@ -1 +1 @@ -dcutr | libp2p

    Function dcutr

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +dcutr | libp2p

    Function dcutr

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_devtools_metrics.index.devToolsMetrics.html b/functions/_libp2p_devtools_metrics.index.devToolsMetrics.html index bb7ed8bad6..0cae3198c6 100644 --- a/functions/_libp2p_devtools_metrics.index.devToolsMetrics.html +++ b/functions/_libp2p_devtools_metrics.index.devToolsMetrics.html @@ -1 +1 @@ -devToolsMetrics | libp2p

    Function devToolsMetrics

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +devToolsMetrics | libp2p

    Function devToolsMetrics

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_echo.echo-1.html b/functions/_libp2p_echo.echo-1.html index 99e97ed63d..545096003e 100644 --- a/functions/_libp2p_echo.echo-1.html +++ b/functions/_libp2p_echo.echo-1.html @@ -1 +1 @@ -echo | libp2p

    Function echo

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +echo | libp2p

    Function echo

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_fetch.fetch-1.html b/functions/_libp2p_fetch.fetch-1.html index 7251b1ed81..e85fd39346 100644 --- a/functions/_libp2p_fetch.fetch-1.html +++ b/functions/_libp2p_fetch.fetch-1.html @@ -1 +1 @@ -fetch | libp2p

    Function fetch

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +fetch | libp2p

    Function fetch

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_floodsub.floodsub.html b/functions/_libp2p_floodsub.floodsub.html index fcbabce695..5ec48c39ce 100644 --- a/functions/_libp2p_floodsub.floodsub.html +++ b/functions/_libp2p_floodsub.floodsub.html @@ -1 +1 @@ -floodsub | libp2p

    Function floodsub

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +floodsub | libp2p

    Function floodsub

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_identify.identify-1.html b/functions/_libp2p_identify.identify-1.html index e7a35762ac..762d349eaf 100644 --- a/functions/_libp2p_identify.identify-1.html +++ b/functions/_libp2p_identify.identify-1.html @@ -1 +1 @@ -identify | libp2p

    Function identify

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +identify | libp2p

    Function identify

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_identify.identifyPush-1.html b/functions/_libp2p_identify.identifyPush-1.html index fdb5ce106d..9f372240f5 100644 --- a/functions/_libp2p_identify.identifyPush-1.html +++ b/functions/_libp2p_identify.identifyPush-1.html @@ -1 +1 @@ -identifyPush | libp2p

    Function identifyPush

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +identifyPush | libp2p

    Function identifyPush

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface.isConnection.html b/functions/_libp2p_interface.isConnection.html index f49bf952c1..86ac936748 100644 --- a/functions/_libp2p_interface.isConnection.html +++ b/functions/_libp2p_interface.isConnection.html @@ -1 +1 @@ -isConnection | libp2p

    Function isConnection

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +isConnection | libp2p

    Function isConnection

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface.isPeerId.html b/functions/_libp2p_interface.isPeerId.html index c5948e64b8..d930879077 100644 --- a/functions/_libp2p_interface.isPeerId.html +++ b/functions/_libp2p_interface.isPeerId.html @@ -1,2 +1,2 @@ isPeerId | libp2p

    Function isPeerId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns other is PeerId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface.isPrivateKey.html b/functions/_libp2p_interface.isPrivateKey.html index ae4bac8600..d25e2191ce 100644 --- a/functions/_libp2p_interface.isPrivateKey.html +++ b/functions/_libp2p_interface.isPrivateKey.html @@ -1,3 +1,3 @@ isPrivateKey | libp2p

    Function isPrivateKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns key is PrivateKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface.isPubSub.html b/functions/_libp2p_interface.isPubSub.html index 792190ea64..56ce30873e 100644 --- a/functions/_libp2p_interface.isPubSub.html +++ b/functions/_libp2p_interface.isPubSub.html @@ -1,2 +1,2 @@ isPubSub | libp2p

    Function isPubSub

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns obj is PubSub<PubSubEvents>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface.isPublicKey.html b/functions/_libp2p_interface.isPublicKey.html index 33a6a467af..e87dd3ae41 100644 --- a/functions/_libp2p_interface.isPublicKey.html +++ b/functions/_libp2p_interface.isPublicKey.html @@ -1,3 +1,3 @@ isPublicKey | libp2p

    Function isPublicKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns key is PublicKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface.isStartable.html b/functions/_libp2p_interface.isStartable.html index ab16d3d394..090ef2e969 100644 --- a/functions/_libp2p_interface.isStartable.html +++ b/functions/_libp2p_interface.isStartable.html @@ -1 +1 @@ -isStartable | libp2p

    Function isStartable

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +isStartable | libp2p

    Function isStartable

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface.isTransport.html b/functions/_libp2p_interface.isTransport.html index a9e907fc71..e3b32fbfa4 100644 --- a/functions/_libp2p_interface.isTransport.html +++ b/functions/_libp2p_interface.isTransport.html @@ -1 +1 @@ -isTransport | libp2p

    Function isTransport

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +isTransport | libp2p

    Function isTransport

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface.setMaxListeners.html b/functions/_libp2p_interface.setMaxListeners.html index 157259add3..534b5b9c7a 100644 --- a/functions/_libp2p_interface.setMaxListeners.html +++ b/functions/_libp2p_interface.setMaxListeners.html @@ -1,2 +1,2 @@ setMaxListeners | libp2p

    Function setMaxListeners

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface.start.html b/functions/_libp2p_interface.start.html index 54e2f5a5d9..e02da0716c 100644 --- a/functions/_libp2p_interface.start.html +++ b/functions/_libp2p_interface.start.html @@ -1 +1 @@ -start | libp2p

    Function start

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +start | libp2p

    Function start

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface.stop.html b/functions/_libp2p_interface.stop.html index fdcf481e37..25651d30ff 100644 --- a/functions/_libp2p_interface.stop.html +++ b/functions/_libp2p_interface.stop.html @@ -1 +1 @@ -stop | libp2p

    Function stop

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +stop | libp2p

    Function stop

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.connection_encryption.default.html b/functions/_libp2p_interface_compliance_tests.connection_encryption.default.html index a5e85e8dce..0ea1324186 100644 --- a/functions/_libp2p_interface_compliance_tests.connection_encryption.default.html +++ b/functions/_libp2p_interface_compliance_tests.connection_encryption.default.html @@ -1 +1 @@ -default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.is_valid_tick.isValidTick.html b/functions/_libp2p_interface_compliance_tests.is_valid_tick.isValidTick.html index f0c5a8e5af..175addc541 100644 --- a/functions/_libp2p_interface_compliance_tests.is_valid_tick.isValidTick.html +++ b/functions/_libp2p_interface_compliance_tests.is_valid_tick.isValidTick.html @@ -1,3 +1,3 @@ isValidTick | libp2p

    Function isValidTick

    • isValidTick(date?, ms?): boolean

    • A tick is considered valid if it happened between now and ms milliseconds ago

      -

      Parameters

      • Optional date: number
      • ms: number = 5000

      Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.matchers.matchMultiaddr.html b/functions/_libp2p_interface_compliance_tests.matchers.matchMultiaddr.html index 752f778151..40dcce4c11 100644 --- a/functions/_libp2p_interface_compliance_tests.matchers.matchMultiaddr.html +++ b/functions/_libp2p_interface_compliance_tests.matchers.matchMultiaddr.html @@ -1,2 +1,2 @@ matchMultiaddr | libp2p

    Function matchMultiaddr

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.matchers.matchPeerId.html b/functions/_libp2p_interface_compliance_tests.matchers.matchPeerId.html index 0497e1887e..578b8f78e4 100644 --- a/functions/_libp2p_interface_compliance_tests.matchers.matchPeerId.html +++ b/functions/_libp2p_interface_compliance_tests.matchers.matchPeerId.html @@ -1,2 +1,2 @@ matchPeerId | libp2p

    Function matchPeerId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.connectionPair.html b/functions/_libp2p_interface_compliance_tests.mocks.connectionPair.html index d2505d7595..11e7609538 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.connectionPair.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.connectionPair.html @@ -1 +1 @@ -connectionPair | libp2p

    Function connectionPair

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +connectionPair | libp2p

    Function connectionPair

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.mockConnection.html b/functions/_libp2p_interface_compliance_tests.mocks.mockConnection.html index 43ceaa68a6..744aeb29b9 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.mockConnection.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.mockConnection.html @@ -1 +1 @@ -mockConnection | libp2p

    Function mockConnection

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mockConnection | libp2p

    Function mockConnection

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.mockConnectionManager.html b/functions/_libp2p_interface_compliance_tests.mocks.mockConnectionManager.html index cdd3d3bb7d..fa6bf2cfe5 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.mockConnectionManager.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.mockConnectionManager.html @@ -1 +1 @@ -mockConnectionManager | libp2p

    Function mockConnectionManager

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mockConnectionManager | libp2p

    Function mockConnectionManager

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.mockDuplex.html b/functions/_libp2p_interface_compliance_tests.mocks.mockDuplex.html index 96394f2930..5c6a5b8d45 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.mockDuplex.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.mockDuplex.html @@ -1 +1 @@ -mockDuplex | libp2p

    Function mockDuplex

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mockDuplex | libp2p

    Function mockDuplex

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.mockMultiaddrConnPair.html b/functions/_libp2p_interface_compliance_tests.mocks.mockMultiaddrConnPair.html index 4eca1c4453..04b98263cd 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.mockMultiaddrConnPair.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.mockMultiaddrConnPair.html @@ -1,2 +1,2 @@ mockMultiaddrConnPair | libp2p

    Function mockMultiaddrConnPair

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns {
        inbound: MultiaddrConnection;
        outbound: MultiaddrConnection;
    }

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.mockMultiaddrConnection.html b/functions/_libp2p_interface_compliance_tests.mocks.mockMultiaddrConnection.html index f2384c28ec..82eba92d70 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.mockMultiaddrConnection.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.mockMultiaddrConnection.html @@ -1 +1 @@ -mockMultiaddrConnection | libp2p

    Function mockMultiaddrConnection

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mockMultiaddrConnection | libp2p

    Function mockMultiaddrConnection

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.mockMuxer.html b/functions/_libp2p_interface_compliance_tests.mocks.mockMuxer.html index abcbe40b05..31e52ffc74 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.mockMuxer.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.mockMuxer.html @@ -1 +1 @@ -mockMuxer | libp2p

    Function mockMuxer

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mockMuxer | libp2p

    Function mockMuxer

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.mockRegistrar.html b/functions/_libp2p_interface_compliance_tests.mocks.mockRegistrar.html index c74d3732f2..2f4e0cb21a 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.mockRegistrar.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.mockRegistrar.html @@ -1 +1 @@ -mockRegistrar | libp2p

    Function mockRegistrar

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mockRegistrar | libp2p

    Function mockRegistrar

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.mockStream.html b/functions/_libp2p_interface_compliance_tests.mocks.mockStream.html index 5c658e514a..b47c53df83 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.mockStream.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.mockStream.html @@ -1 +1 @@ -mockStream | libp2p

    Function mockStream

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mockStream | libp2p

    Function mockStream

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.mockUpgrader.html b/functions/_libp2p_interface_compliance_tests.mocks.mockUpgrader.html index a56f31d996..ece4ac91db 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.mockUpgrader.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.mockUpgrader.html @@ -1 +1 @@ -mockUpgrader | libp2p

    Function mockUpgrader

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mockUpgrader | libp2p

    Function mockUpgrader

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.streamPair.html b/functions/_libp2p_interface_compliance_tests.mocks.streamPair.html index 9b7efcb8ef..7411ae88ce 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.streamPair.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.streamPair.html @@ -1 +1 @@ -streamPair | libp2p

    Function streamPair

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +streamPair | libp2p

    Function streamPair

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.peer_discovery.default.html b/functions/_libp2p_interface_compliance_tests.peer_discovery.default.html index d941585474..46488445c3 100644 --- a/functions/_libp2p_interface_compliance_tests.peer_discovery.default.html +++ b/functions/_libp2p_interface_compliance_tests.peer_discovery.default.html @@ -1 +1 @@ -default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.pubsub.default.html b/functions/_libp2p_interface_compliance_tests.pubsub.default.html index 0fd2a543ad..bebee04fb5 100644 --- a/functions/_libp2p_interface_compliance_tests.pubsub.default.html +++ b/functions/_libp2p_interface_compliance_tests.pubsub.default.html @@ -1 +1 @@ -default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.stream_muxer.default.html b/functions/_libp2p_interface_compliance_tests.stream_muxer.default.html index d2c4540cf0..3f9a82f00c 100644 --- a/functions/_libp2p_interface_compliance_tests.stream_muxer.default.html +++ b/functions/_libp2p_interface_compliance_tests.stream_muxer.default.html @@ -1 +1 @@ -default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.transport.default.html b/functions/_libp2p_interface_compliance_tests.transport.default.html index 77f9f825ca..517f21c691 100644 --- a/functions/_libp2p_interface_compliance_tests.transport.default.html +++ b/functions/_libp2p_interface_compliance_tests.transport.default.html @@ -1 +1 @@ -default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_kad_dht.MessageType.codec.html b/functions/_libp2p_kad_dht.MessageType.codec.html index ad374adeab..645f04a37d 100644 --- a/functions/_libp2p_kad_dht.MessageType.codec.html +++ b/functions/_libp2p_kad_dht.MessageType.codec.html @@ -1 +1 @@ -codec | libp2p

    Function codec

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +codec | libp2p

    Function codec

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_kad_dht.kadDHT-1.html b/functions/_libp2p_kad_dht.kadDHT-1.html index 0e834e7d3d..ba32ac7d96 100644 --- a/functions/_libp2p_kad_dht.kadDHT-1.html +++ b/functions/_libp2p_kad_dht.kadDHT-1.html @@ -1,3 +1,3 @@ kadDHT | libp2p

    Function kadDHT

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns ((components) => KadDHT)

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_kad_dht.passthroughMapper.html b/functions/_libp2p_kad_dht.passthroughMapper.html index 4688619491..f1392101d8 100644 --- a/functions/_libp2p_kad_dht.passthroughMapper.html +++ b/functions/_libp2p_kad_dht.passthroughMapper.html @@ -1 +1 @@ -passthroughMapper | libp2p

    Function passthroughMapper

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +passthroughMapper | libp2p

    Function passthroughMapper

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_kad_dht.removePrivateAddressesMapper.html b/functions/_libp2p_kad_dht.removePrivateAddressesMapper.html index e49438439b..2a1ee68e7c 100644 --- a/functions/_libp2p_kad_dht.removePrivateAddressesMapper.html +++ b/functions/_libp2p_kad_dht.removePrivateAddressesMapper.html @@ -1 +1 @@ -removePrivateAddressesMapper | libp2p

    Function removePrivateAddressesMapper

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +removePrivateAddressesMapper | libp2p

    Function removePrivateAddressesMapper

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_kad_dht.removePublicAddressesMapper.html b/functions/_libp2p_kad_dht.removePublicAddressesMapper.html index fceaf06f09..e871db458c 100644 --- a/functions/_libp2p_kad_dht.removePublicAddressesMapper.html +++ b/functions/_libp2p_kad_dht.removePublicAddressesMapper.html @@ -1 +1 @@ -removePublicAddressesMapper | libp2p

    Function removePublicAddressesMapper

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +removePublicAddressesMapper | libp2p

    Function removePublicAddressesMapper

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_keychain.keychain-1.html b/functions/_libp2p_keychain.keychain-1.html index 307c879799..fe4243b3a4 100644 --- a/functions/_libp2p_keychain.keychain-1.html +++ b/functions/_libp2p_keychain.keychain-1.html @@ -1 +1 @@ -keychain | libp2p

    Function keychain

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +keychain | libp2p

    Function keychain

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_logger.defaultLogger.html b/functions/_libp2p_logger.defaultLogger.html index 78ce58dd68..54e0b3a5d6 100644 --- a/functions/_libp2p_logger.defaultLogger.html +++ b/functions/_libp2p_logger.defaultLogger.html @@ -1,4 +1,4 @@ defaultLogger | libp2p

    Function defaultLogger

    • defaultLogger(): ComponentLogger

    • Create a component logger

      Returns ComponentLogger

      Example

      import { defaultLogger } from '@libp2p/logger'
      import { peerIdFromString } from '@libp2p/peer-id'

      const logger = defaultLogger()

      const log = logger.forComponent('my-component')
      log.info('hello world')
      // logs "my-component hello world"
      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_logger.disable.html b/functions/_libp2p_logger.disable.html index 951997d88e..c986829dd0 100644 --- a/functions/_libp2p_logger.disable.html +++ b/functions/_libp2p_logger.disable.html @@ -1 +1 @@ -disable | libp2p

    Function disable

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +disable | libp2p

    Function disable

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_logger.enable.html b/functions/_libp2p_logger.enable.html index b8fe2c58b0..33e159a487 100644 --- a/functions/_libp2p_logger.enable.html +++ b/functions/_libp2p_logger.enable.html @@ -1 +1 @@ -enable | libp2p

    Function enable

    • enable(namespaces): void

    • Parameters

      • namespaces: string

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +enable | libp2p

    Function enable

    • enable(namespaces): void

    • Parameters

      • namespaces: string

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_logger.enabled.html b/functions/_libp2p_logger.enabled.html index 522d38b4ae..e94216ce30 100644 --- a/functions/_libp2p_logger.enabled.html +++ b/functions/_libp2p_logger.enabled.html @@ -1 +1 @@ -enabled | libp2p

    Function enabled

    • enabled(namespaces): boolean

    • Parameters

      • namespaces: string

      Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +enabled | libp2p

    Function enabled

    • enabled(namespaces): boolean

    • Parameters

      • namespaces: string

      Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_logger.logger-1.html b/functions/_libp2p_logger.logger-1.html index 4e9593a98c..dc277b8e05 100644 --- a/functions/_libp2p_logger.logger-1.html +++ b/functions/_libp2p_logger.logger-1.html @@ -1,4 +1,4 @@ logger | libp2p

    Function logger

    • logger(name): Logger

    • Creates a logger for the passed component name.

      Parameters

      • name: string

      Returns Logger

      Example

      import { logger } from '@libp2p/logger'

      const log = logger('my-component')
      log.info('hello world')
      // logs "my-component hello world"
      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_logger.peerLogger.html b/functions/_libp2p_logger.peerLogger.html index dfa51b25c3..338bf60fc8 100644 --- a/functions/_libp2p_logger.peerLogger.html +++ b/functions/_libp2p_logger.peerLogger.html @@ -2,4 +2,4 @@ peer id.

    Parameters

    Returns ComponentLogger

    Example

    import { peerLogger } from '@libp2p/logger'
    import { peerIdFromString } from '@libp2p/peer-id'

    const peerId = peerIdFromString('12D3FooBar')
    const logger = peerLogger(peerId)

    const log = logger.forComponent('my-component')
    log.info('hello world')
    // logs "12…oBar:my-component hello world"
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_logger.prefixLogger.html b/functions/_libp2p_logger.prefixLogger.html index 82614fe81b..18c59528c9 100644 --- a/functions/_libp2p_logger.prefixLogger.html +++ b/functions/_libp2p_logger.prefixLogger.html @@ -2,4 +2,4 @@ string.

    Parameters

    Returns ComponentLogger

    Example

    import { prefixLogger } from '@libp2p/logger'

    const logger = prefixLogger('my-node')

    const log = logger.forComponent('my-component')
    log.info('hello world')
    // logs "my-node:my-component hello world"
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_mdns.mdns.html b/functions/_libp2p_mdns.mdns.html index 808425cd13..2b9b8de026 100644 --- a/functions/_libp2p_mdns.mdns.html +++ b/functions/_libp2p_mdns.mdns.html @@ -1 +1 @@ -mdns | libp2p

    Function mdns

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mdns | libp2p

    Function mdns

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_memory.memory.html b/functions/_libp2p_memory.memory.html index c1b3dced79..fd4ff96ce1 100644 --- a/functions/_libp2p_memory.memory.html +++ b/functions/_libp2p_memory.memory.html @@ -1 +1 @@ -memory | libp2p

    Function memory

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +memory | libp2p

    Function memory

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_mplex.mplex.html b/functions/_libp2p_mplex.mplex.html index b6929af768..414ff94164 100644 --- a/functions/_libp2p_mplex.mplex.html +++ b/functions/_libp2p_mplex.mplex.html @@ -1,2 +1,2 @@ mplex | libp2p

    Function mplex

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_multistream_select.handle.html b/functions/_libp2p_multistream_select.handle.html index 2bb60e8deb..3733be5744 100644 --- a/functions/_libp2p_multistream_select.handle.html +++ b/functions/_libp2p_multistream_select.handle.html @@ -6,4 +6,4 @@

    Returns Promise<ProtocolStream<Stream>>

    A stream for the selected protocol and the protocol that was selected from the list of protocols provided to select

    Example

    import { pipe } from 'it-pipe'
    import * as mss from '@libp2p/multistream-select'
    import { Mplex } from '@libp2p/mplex'

    const muxer = new Mplex({
      async onStream (muxedStream) {
      // mss.handle(handledProtocols)
      // Returns selected stream and protocol
      const { stream, protocol } = await mss.handle(muxedStream, [
        '/ipfs-dht/1.0.0',
        '/ipfs-bitswap/1.0.0'
      ])

      // Typically here we'd call the handler function that was registered in
      // libp2p for the given protocol:
      // e.g. handlers[protocol].handler(stream)
      //
      // If protocol was /ipfs-dht/1.0.0 it might do something like this:
      // try {
      //   await pipe(
      //     dhtStream,
      //     source => (async function * () {
      //       for await (const chunk of source)
      //         // Incoming DHT data -> process and yield to respond
      //     })(),
      //     dhtStream
      //   )
      // } catch (err) {
      //   // Error in stream
      // }
      }
    })
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_multistream_select.select.html b/functions/_libp2p_multistream_select.select.html index d2f0e46632..ff6e97f2df 100644 --- a/functions/_libp2p_multistream_select.select.html +++ b/functions/_libp2p_multistream_select.select.html @@ -5,4 +5,4 @@

    Returns Promise<ProtocolStream<Stream>>

    A stream for the selected protocol and the protocol that was selected from the list of protocols provided to select.

    Example

    import { pipe } from 'it-pipe'
    import * as mss from '@libp2p/multistream-select'
    import { Mplex } from '@libp2p/mplex'

    const muxer = new Mplex()
    const muxedStream = muxer.newStream()

    // mss.select(protocol(s))
    // Select from one of the passed protocols (in priority order)
    // Returns selected stream and protocol
    const { stream: dhtStream, protocol } = await mss.select(muxedStream, [
      // This might just be different versions of DHT, but could be different impls
      '/ipfs-dht/2.0.0', // Most of the time this will probably just be one item.
      '/ipfs-dht/1.0.0'
    ])

    // Typically this stream will be passed back to the caller of libp2p.dialProtocol
    //
    // ...it might then do something like this:
    // try {
    //   await pipe(
    //     [uint8ArrayFromString('Some DHT data')]
    //     dhtStream,
    //     async source => {
    //       for await (const chunk of source)
    //         // DHT response data
    //     }
    //   )
    // } catch (err) {
    //   // Error in stream
    // }
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_opentelemetry_metrics.openTelemetryMetrics.html b/functions/_libp2p_opentelemetry_metrics.openTelemetryMetrics.html index 91c945ae00..f120839f4b 100644 --- a/functions/_libp2p_opentelemetry_metrics.openTelemetryMetrics.html +++ b/functions/_libp2p_opentelemetry_metrics.openTelemetryMetrics.html @@ -1 +1 @@ -openTelemetryMetrics | libp2p

    Function openTelemetryMetrics

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +openTelemetryMetrics | libp2p

    Function openTelemetryMetrics

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_collections.peerFilter-1.html b/functions/_libp2p_peer_collections.peerFilter-1.html index 14e0a6cf5b..13692451b0 100644 --- a/functions/_libp2p_peer_collections.peerFilter-1.html +++ b/functions/_libp2p_peer_collections.peerFilter-1.html @@ -1,4 +1,4 @@ peerFilter | libp2p

    Function peerFilter

    • peerFilter(size, errorRate?): PeerFilter

    • Create and return a PeerFilter

      Parameters

      • size: number

        The maximum number of peers expected to be added to the filter

      • errorRate: number = 0.001

        The acceptable error rate

        -

      Returns PeerFilter

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns PeerFilter

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_collections.peerList-1.html b/functions/_libp2p_peer_collections.peerList-1.html index a9f0edd801..a071bc0937 100644 --- a/functions/_libp2p_peer_collections.peerList-1.html +++ b/functions/_libp2p_peer_collections.peerList-1.html @@ -1 +1 @@ -peerList | libp2p

    Function peerList

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +peerList | libp2p

    Function peerList

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_collections.peerMap-1.html b/functions/_libp2p_peer_collections.peerMap-1.html index 513187d573..dd91219da6 100644 --- a/functions/_libp2p_peer_collections.peerMap-1.html +++ b/functions/_libp2p_peer_collections.peerMap-1.html @@ -1 +1 @@ -peerMap | libp2p

    Function peerMap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +peerMap | libp2p

    Function peerMap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_collections.peerSet-1.html b/functions/_libp2p_peer_collections.peerSet-1.html index edf43888f9..52b470f49f 100644 --- a/functions/_libp2p_peer_collections.peerSet-1.html +++ b/functions/_libp2p_peer_collections.peerSet-1.html @@ -1 +1 @@ -peerSet | libp2p

    Function peerSet

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +peerSet | libp2p

    Function peerSet

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_collections.trackedPeerList.html b/functions/_libp2p_peer_collections.trackedPeerList.html index 767d4ba081..ec6856b968 100644 --- a/functions/_libp2p_peer_collections.trackedPeerList.html +++ b/functions/_libp2p_peer_collections.trackedPeerList.html @@ -10,4 +10,4 @@

    const list = trackedPeerList({ name: 'my_metric_name', metrics: libp2p.metrics }) list.push(peerId) ```

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_collections.trackedPeerMap.html b/functions/_libp2p_peer_collections.trackedPeerMap.html index 47c13c1543..acbc3795ac 100644 --- a/functions/_libp2p_peer_collections.trackedPeerMap.html +++ b/functions/_libp2p_peer_collections.trackedPeerMap.html @@ -10,4 +10,4 @@

    const list = trackedPeerMap({ name: 'my_metric_name', metrics: libp2p.metrics }) map.set(peerId, 'value') ```

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_collections.trackedPeerSet.html b/functions/_libp2p_peer_collections.trackedPeerSet.html index 63ef114b8f..b5e29ea613 100644 --- a/functions/_libp2p_peer_collections.trackedPeerSet.html +++ b/functions/_libp2p_peer_collections.trackedPeerSet.html @@ -10,4 +10,4 @@

    const list = trackedPeerSet({ name: 'my_metric_name', metrics: libp2p.metrics }) map.add(peerId) ```

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_id.peerIdFromCID.html b/functions/_libp2p_peer_id.peerIdFromCID.html index 02ac762ea1..7ecd3921cb 100644 --- a/functions/_libp2p_peer_id.peerIdFromCID.html +++ b/functions/_libp2p_peer_id.peerIdFromCID.html @@ -1 +1 @@ -peerIdFromCID | libp2p

    Function peerIdFromCID

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +peerIdFromCID | libp2p

    Function peerIdFromCID

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_id.peerIdFromMultihash.html b/functions/_libp2p_peer_id.peerIdFromMultihash.html index afc278b169..472c32e20d 100644 --- a/functions/_libp2p_peer_id.peerIdFromMultihash.html +++ b/functions/_libp2p_peer_id.peerIdFromMultihash.html @@ -1 +1 @@ -peerIdFromMultihash | libp2p

    Function peerIdFromMultihash

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +peerIdFromMultihash | libp2p

    Function peerIdFromMultihash

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_id.peerIdFromPrivateKey.html b/functions/_libp2p_peer_id.peerIdFromPrivateKey.html index ab2e88174b..1227fc82c8 100644 --- a/functions/_libp2p_peer_id.peerIdFromPrivateKey.html +++ b/functions/_libp2p_peer_id.peerIdFromPrivateKey.html @@ -1 +1 @@ -peerIdFromPrivateKey | libp2p

    Function peerIdFromPrivateKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +peerIdFromPrivateKey | libp2p

    Function peerIdFromPrivateKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_id.peerIdFromPublicKey.html b/functions/_libp2p_peer_id.peerIdFromPublicKey.html index b633eec2ad..50c7591066 100644 --- a/functions/_libp2p_peer_id.peerIdFromPublicKey.html +++ b/functions/_libp2p_peer_id.peerIdFromPublicKey.html @@ -1 +1 @@ -peerIdFromPublicKey | libp2p

    Function peerIdFromPublicKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +peerIdFromPublicKey | libp2p

    Function peerIdFromPublicKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_id.peerIdFromString.html b/functions/_libp2p_peer_id.peerIdFromString.html index b810c17c63..ad6097a63b 100644 --- a/functions/_libp2p_peer_id.peerIdFromString.html +++ b/functions/_libp2p_peer_id.peerIdFromString.html @@ -1 +1 @@ -peerIdFromString | libp2p

    Function peerIdFromString

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +peerIdFromString | libp2p

    Function peerIdFromString

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_store.persistentPeerStore.html b/functions/_libp2p_peer_store.persistentPeerStore.html index 1d03a988aa..6900428466 100644 --- a/functions/_libp2p_peer_store.persistentPeerStore.html +++ b/functions/_libp2p_peer_store.persistentPeerStore.html @@ -1 +1 @@ -persistentPeerStore | libp2p

    Function persistentPeerStore

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +persistentPeerStore | libp2p

    Function persistentPeerStore

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_perf.perf-1.html b/functions/_libp2p_perf.perf-1.html index c289c7ddf4..fd2a7f8ef5 100644 --- a/functions/_libp2p_perf.perf-1.html +++ b/functions/_libp2p_perf.perf-1.html @@ -1 +1 @@ -perf | libp2p

    Function perf

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +perf | libp2p

    Function perf

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_ping.ping.html b/functions/_libp2p_ping.ping.html index 41c4131ea4..658f5d9601 100644 --- a/functions/_libp2p_ping.ping.html +++ b/functions/_libp2p_ping.ping.html @@ -1 +1 @@ -ping | libp2p

    Function ping

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ping | libp2p

    Function ping

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_plaintext.plaintext.html b/functions/_libp2p_plaintext.plaintext.html index a95be37caf..412493eb54 100644 --- a/functions/_libp2p_plaintext.plaintext.html +++ b/functions/_libp2p_plaintext.plaintext.html @@ -1 +1 @@ -plaintext | libp2p

    Function plaintext

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +plaintext | libp2p

    Function plaintext

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pnet.generateKey.html b/functions/_libp2p_pnet.generateKey.html index bc96c99eec..ceea324107 100644 --- a/functions/_libp2p_pnet.generateKey.html +++ b/functions/_libp2p_pnet.generateKey.html @@ -1,3 +1,3 @@ generateKey | libp2p

    Function generateKey

    • generateKey(bytes): void

    • Generates a PSK that can be used in a libp2p-pnet private network

      Parameters

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pnet.preSharedKey.html b/functions/_libp2p_pnet.preSharedKey.html index 878c4e30e8..ed7b73cfa1 100644 --- a/functions/_libp2p_pnet.preSharedKey.html +++ b/functions/_libp2p_pnet.preSharedKey.html @@ -1 +1 @@ -preSharedKey | libp2p

    Function preSharedKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +preSharedKey | libp2p

    Function preSharedKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_prometheus_metrics.prometheusMetrics.html b/functions/_libp2p_prometheus_metrics.prometheusMetrics.html index 26d9cf0b8a..4b1ca7ce92 100644 --- a/functions/_libp2p_prometheus_metrics.prometheusMetrics.html +++ b/functions/_libp2p_prometheus_metrics.prometheusMetrics.html @@ -1 +1 @@ -prometheusMetrics | libp2p

    Function prometheusMetrics

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +prometheusMetrics | libp2p

    Function prometheusMetrics

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pubsub.utils.anyMatch.html b/functions/_libp2p_pubsub.utils.anyMatch.html index 1558d99bc1..4d315686ce 100644 --- a/functions/_libp2p_pubsub.utils.anyMatch.html +++ b/functions/_libp2p_pubsub.utils.anyMatch.html @@ -1,3 +1,3 @@ anyMatch | libp2p

    Function anyMatch

    • anyMatch(a, b): boolean

    • Check if any member of the first set is also a member of the second set

      -

      Parameters

      • a: Set<number> | number[]
      • b: Set<number> | number[]

      Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pubsub.utils.bigIntFromBytes.html b/functions/_libp2p_pubsub.utils.bigIntFromBytes.html index 5a725e7e1c..b55eea31f5 100644 --- a/functions/_libp2p_pubsub.utils.bigIntFromBytes.html +++ b/functions/_libp2p_pubsub.utils.bigIntFromBytes.html @@ -1 +1 @@ -bigIntFromBytes | libp2p

    Function bigIntFromBytes

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +bigIntFromBytes | libp2p

    Function bigIntFromBytes

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pubsub.utils.bigIntToBytes.html b/functions/_libp2p_pubsub.utils.bigIntToBytes.html index 2f066b4200..2f13262a5b 100644 --- a/functions/_libp2p_pubsub.utils.bigIntToBytes.html +++ b/functions/_libp2p_pubsub.utils.bigIntToBytes.html @@ -1 +1 @@ -bigIntToBytes | libp2p

    Function bigIntToBytes

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +bigIntToBytes | libp2p

    Function bigIntToBytes

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pubsub.utils.ensureArray.html b/functions/_libp2p_pubsub.utils.ensureArray.html index d39c3d1378..979a229bb7 100644 --- a/functions/_libp2p_pubsub.utils.ensureArray.html +++ b/functions/_libp2p_pubsub.utils.ensureArray.html @@ -1,2 +1,2 @@ ensureArray | libp2p

    Function ensureArray

    • ensureArray<T>(maybeArray): T[]

    • Make everything an array

      -

      Type Parameters

      • T

      Parameters

      • maybeArray: T | T[]

      Returns T[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns T[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pubsub.utils.msgId.html b/functions/_libp2p_pubsub.utils.msgId.html index db9940325c..7d43b290ee 100644 --- a/functions/_libp2p_pubsub.utils.msgId.html +++ b/functions/_libp2p_pubsub.utils.msgId.html @@ -1,2 +1,2 @@ msgId | libp2p

    Function msgId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Uint8Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pubsub.utils.noSignMsgId.html b/functions/_libp2p_pubsub.utils.noSignMsgId.html index a5f9316c9d..1e3f33a048 100644 --- a/functions/_libp2p_pubsub.utils.noSignMsgId.html +++ b/functions/_libp2p_pubsub.utils.noSignMsgId.html @@ -1,2 +1,2 @@ noSignMsgId | libp2p

    Function noSignMsgId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Uint8Array | Promise<Uint8Array>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pubsub.utils.randomSeqno.html b/functions/_libp2p_pubsub.utils.randomSeqno.html index 2f6773cac0..2dd8e9cb35 100644 --- a/functions/_libp2p_pubsub.utils.randomSeqno.html +++ b/functions/_libp2p_pubsub.utils.randomSeqno.html @@ -1,2 +1,2 @@ randomSeqno | libp2p

    Function randomSeqno

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns bigint

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pubsub.utils.toMessage.html b/functions/_libp2p_pubsub.utils.toMessage.html index fb19cb8b82..fbcfcae944 100644 --- a/functions/_libp2p_pubsub.utils.toMessage.html +++ b/functions/_libp2p_pubsub.utils.toMessage.html @@ -1 +1 @@ -toMessage | libp2p

    Function toMessage

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +toMessage | libp2p

    Function toMessage

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pubsub.utils.toRpcMessage.html b/functions/_libp2p_pubsub.utils.toRpcMessage.html index b982c51dc1..b77b013531 100644 --- a/functions/_libp2p_pubsub.utils.toRpcMessage.html +++ b/functions/_libp2p_pubsub.utils.toRpcMessage.html @@ -1 +1 @@ -toRpcMessage | libp2p

    Function toRpcMessage

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +toRpcMessage | libp2p

    Function toRpcMessage

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_simple_metrics.simpleMetrics.html b/functions/_libp2p_simple_metrics.simpleMetrics.html index ed2074d16c..5f12bd696d 100644 --- a/functions/_libp2p_simple_metrics.simpleMetrics.html +++ b/functions/_libp2p_simple_metrics.simpleMetrics.html @@ -1 +1 @@ -simpleMetrics | libp2p

    Function simpleMetrics

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +simpleMetrics | libp2p

    Function simpleMetrics

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_tcp.tcp.html b/functions/_libp2p_tcp.tcp.html index e43eb6ec5f..5768f299b1 100644 --- a/functions/_libp2p_tcp.tcp.html +++ b/functions/_libp2p_tcp.tcp.html @@ -1 +1 @@ -tcp | libp2p

    Function tcp

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +tcp | libp2p

    Function tcp

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_tls.tls.html b/functions/_libp2p_tls.tls.html index 23f598fb00..4b8f1978c5 100644 --- a/functions/_libp2p_tls.tls.html +++ b/functions/_libp2p_tls.tls.html @@ -1 +1 @@ -tls | libp2p

    Function tls

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +tls | libp2p

    Function tls

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_upnp_nat.uPnPNAT-1.html b/functions/_libp2p_upnp_nat.uPnPNAT-1.html index 8f418c4370..8711111d10 100644 --- a/functions/_libp2p_upnp_nat.uPnPNAT-1.html +++ b/functions/_libp2p_upnp_nat.uPnPNAT-1.html @@ -1 +1 @@ -uPnPNAT | libp2p

    Function uPnPNAT

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +uPnPNAT | libp2p

    Function uPnPNAT

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.abort_options.createTimeoutOptions.html b/functions/_libp2p_utils.abort_options.createTimeoutOptions.html index 28f68eb01d..d07bbd6022 100644 --- a/functions/_libp2p_utils.abort_options.createTimeoutOptions.html +++ b/functions/_libp2p_utils.abort_options.createTimeoutOptions.html @@ -1 +1 @@ -createTimeoutOptions | libp2p

    Function createTimeoutOptions

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +createTimeoutOptions | libp2p

    Function createTimeoutOptions

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.array_equals.arrayEquals.html b/functions/_libp2p_utils.array_equals.arrayEquals.html index 059dea454e..3e0b44846d 100644 --- a/functions/_libp2p_utils.array_equals.arrayEquals.html +++ b/functions/_libp2p_utils.array_equals.arrayEquals.html @@ -1,3 +1,3 @@ arrayEquals | libp2p

    Function arrayEquals

    • arrayEquals(a, b): boolean

    • Verify if two arrays of non primitive types with the "equals" function are equal. Compatible with multiaddr, peer-id and others.

      -

      Parameters

      • a: any[]
      • b: any[]

      Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.close.safelyCloseConnectionIfUnused.html b/functions/_libp2p_utils.close.safelyCloseConnectionIfUnused.html index 78cce34228..3fa14bb42b 100644 --- a/functions/_libp2p_utils.close.safelyCloseConnectionIfUnused.html +++ b/functions/_libp2p_utils.close.safelyCloseConnectionIfUnused.html @@ -1,3 +1,3 @@ safelyCloseConnectionIfUnused | libp2p

    Function safelyCloseConnectionIfUnused

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.close.safelyCloseStream.html b/functions/_libp2p_utils.close.safelyCloseStream.html index 4e8317837c..af002296f7 100644 --- a/functions/_libp2p_utils.close.safelyCloseStream.html +++ b/functions/_libp2p_utils.close.safelyCloseStream.html @@ -1,3 +1,3 @@ safelyCloseStream | libp2p

    Function safelyCloseStream

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.close_source.closeSource.html b/functions/_libp2p_utils.close_source.closeSource.html index f63bd6231f..e6824624a5 100644 --- a/functions/_libp2p_utils.close_source.closeSource.html +++ b/functions/_libp2p_utils.close_source.closeSource.html @@ -1 +1 @@ -closeSource | libp2p

    Function closeSource

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +closeSource | libp2p

    Function closeSource

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.debounce.debounce.html b/functions/_libp2p_utils.debounce.debounce.html index e4c307c776..c338fc1d21 100644 --- a/functions/_libp2p_utils.debounce.debounce.html +++ b/functions/_libp2p_utils.debounce.debounce.html @@ -1,3 +1,3 @@ debounce | libp2p

    Function debounce

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns DebouncedFunction

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.filters.createBloomFilter.html b/functions/_libp2p_utils.filters.createBloomFilter.html index a693bbc0e3..b5d59234b9 100644 --- a/functions/_libp2p_utils.filters.createBloomFilter.html +++ b/functions/_libp2p_utils.filters.createBloomFilter.html @@ -1,3 +1,3 @@ createBloomFilter | libp2p

    Function createBloomFilter

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Filter

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.filters.createCuckooFilter.html b/functions/_libp2p_utils.filters.createCuckooFilter.html index aa8f70b067..0b3b6ffa00 100644 --- a/functions/_libp2p_utils.filters.createCuckooFilter.html +++ b/functions/_libp2p_utils.filters.createCuckooFilter.html @@ -1 +1 @@ -createCuckooFilter | libp2p

    Function createCuckooFilter

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +createCuckooFilter | libp2p

    Function createCuckooFilter

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.filters.createScalableCuckooFilter.html b/functions/_libp2p_utils.filters.createScalableCuckooFilter.html index ecb38e4708..14b23fc759 100644 --- a/functions/_libp2p_utils.filters.createScalableCuckooFilter.html +++ b/functions/_libp2p_utils.filters.createScalableCuckooFilter.html @@ -1 +1 @@ -createScalableCuckooFilter | libp2p

    Function createScalableCuckooFilter

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +createScalableCuckooFilter | libp2p

    Function createScalableCuckooFilter

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.global_unicast_ip.isGlobalUnicastIp.html b/functions/_libp2p_utils.global_unicast_ip.isGlobalUnicastIp.html index 329b123d95..35e2a4d9dc 100644 --- a/functions/_libp2p_utils.global_unicast_ip.isGlobalUnicastIp.html +++ b/functions/_libp2p_utils.global_unicast_ip.isGlobalUnicastIp.html @@ -1 +1 @@ -isGlobalUnicastIp | libp2p

    Function isGlobalUnicastIp

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +isGlobalUnicastIp | libp2p

    Function isGlobalUnicastIp

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.ip_port_to_multiaddr.ipPortToMultiaddr.html b/functions/_libp2p_utils.ip_port_to_multiaddr.ipPortToMultiaddr.html index bc6c16cacb..551b57d887 100644 --- a/functions/_libp2p_utils.ip_port_to_multiaddr.ipPortToMultiaddr.html +++ b/functions/_libp2p_utils.ip_port_to_multiaddr.ipPortToMultiaddr.html @@ -1,2 +1,2 @@ ipPortToMultiaddr | libp2p

    Function ipPortToMultiaddr

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Multiaddr

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.is_promise.isPromise.html b/functions/_libp2p_utils.is_promise.isPromise.html index 3b9009b92d..d5ad98e736 100644 --- a/functions/_libp2p_utils.is_promise.isPromise.html +++ b/functions/_libp2p_utils.is_promise.isPromise.html @@ -1 +1 @@ -isPromise | libp2p

    Function isPromise

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +isPromise | libp2p

    Function isPromise

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.link_local_ip.isLinkLocalIp.html b/functions/_libp2p_utils.link_local_ip.isLinkLocalIp.html index 589ffc2231..54d3d6ac6a 100644 --- a/functions/_libp2p_utils.link_local_ip.isLinkLocalIp.html +++ b/functions/_libp2p_utils.link_local_ip.isLinkLocalIp.html @@ -1 +1 @@ -isLinkLocalIp | libp2p

    Function isLinkLocalIp

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +isLinkLocalIp | libp2p

    Function isLinkLocalIp

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.multiaddr_is_global_unicast.isGlobalUnicast.html b/functions/_libp2p_utils.multiaddr_is_global_unicast.isGlobalUnicast.html index aa1bb6078c..93f0b5ddbd 100644 --- a/functions/_libp2p_utils.multiaddr_is_global_unicast.isGlobalUnicast.html +++ b/functions/_libp2p_utils.multiaddr_is_global_unicast.isGlobalUnicast.html @@ -1,2 +1,2 @@ isGlobalUnicast | libp2p

    Function isGlobalUnicast

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.multiaddr_is_link_local.isLinkLocal.html b/functions/_libp2p_utils.multiaddr_is_link_local.isLinkLocal.html index 6ebdeef829..edec6ab6d7 100644 --- a/functions/_libp2p_utils.multiaddr_is_link_local.isLinkLocal.html +++ b/functions/_libp2p_utils.multiaddr_is_link_local.isLinkLocal.html @@ -1,2 +1,2 @@ isLinkLocal | libp2p

    Function isLinkLocal

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.multiaddr_is_loopback.isLoopback.html b/functions/_libp2p_utils.multiaddr_is_loopback.isLoopback.html index 57e4af6bdd..9a06af07a6 100644 --- a/functions/_libp2p_utils.multiaddr_is_loopback.isLoopback.html +++ b/functions/_libp2p_utils.multiaddr_is_loopback.isLoopback.html @@ -1,2 +1,2 @@ isLoopback | libp2p

    Function isLoopback

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.multiaddr_is_private.isPrivate.html b/functions/_libp2p_utils.multiaddr_is_private.isPrivate.html index 69b830b264..b819417835 100644 --- a/functions/_libp2p_utils.multiaddr_is_private.isPrivate.html +++ b/functions/_libp2p_utils.multiaddr_is_private.isPrivate.html @@ -1,2 +1,2 @@ isPrivate | libp2p

    Function isPrivate

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.private_ip.isPrivateIp.html b/functions/_libp2p_utils.private_ip.isPrivateIp.html index 6a4b3f71d5..344b97ba43 100644 --- a/functions/_libp2p_utils.private_ip.isPrivateIp.html +++ b/functions/_libp2p_utils.private_ip.isPrivateIp.html @@ -1 +1 @@ -isPrivateIp | libp2p

    Function isPrivateIp

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +isPrivateIp | libp2p

    Function isPrivateIp

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.repeating_task.repeatingTask-1.html b/functions/_libp2p_utils.repeating_task.repeatingTask-1.html index 708fd15a8c..332a6c1d7a 100644 --- a/functions/_libp2p_utils.repeating_task.repeatingTask-1.html +++ b/functions/_libp2p_utils.repeating_task.repeatingTask-1.html @@ -1 +1 @@ -repeatingTask | libp2p

    Function repeatingTask

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +repeatingTask | libp2p

    Function repeatingTask

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.stream_to_ma_conn.streamToMaConnection.html b/functions/_libp2p_utils.stream_to_ma_conn.streamToMaConnection.html index a0a4123689..ccf0a849d7 100644 --- a/functions/_libp2p_utils.stream_to_ma_conn.streamToMaConnection.html +++ b/functions/_libp2p_utils.stream_to_ma_conn.streamToMaConnection.html @@ -1,3 +1,3 @@ streamToMaConnection | libp2p

    Function streamToMaConnection

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns MultiaddrConnection

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.tracked_list.trackedList.html b/functions/_libp2p_utils.tracked_list.trackedList.html index c42f8bff9a..d3a39ea192 100644 --- a/functions/_libp2p_utils.tracked_list.trackedList.html +++ b/functions/_libp2p_utils.tracked_list.trackedList.html @@ -1 +1 @@ -trackedList | libp2p

    Function trackedList

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +trackedList | libp2p

    Function trackedList

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.tracked_map.trackedMap.html b/functions/_libp2p_utils.tracked_map.trackedMap.html index 98c745aad9..74db6011e1 100644 --- a/functions/_libp2p_utils.tracked_map.trackedMap.html +++ b/functions/_libp2p_utils.tracked_map.trackedMap.html @@ -1 +1 @@ -trackedMap | libp2p

    Function trackedMap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +trackedMap | libp2p

    Function trackedMap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_webrtc.webRTC.html b/functions/_libp2p_webrtc.webRTC.html index a083cec374..8507ddad89 100644 --- a/functions/_libp2p_webrtc.webRTC.html +++ b/functions/_libp2p_webrtc.webRTC.html @@ -1 +1 @@ -webRTC | libp2p

    Function webRTC

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +webRTC | libp2p

    Function webRTC

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_webrtc.webRTCDirect.html b/functions/_libp2p_webrtc.webRTCDirect.html index 9c4824b818..29da00a015 100644 --- a/functions/_libp2p_webrtc.webRTCDirect.html +++ b/functions/_libp2p_webrtc.webRTCDirect.html @@ -1 +1 @@ -webRTCDirect | libp2p

    Function webRTCDirect

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +webRTCDirect | libp2p

    Function webRTCDirect

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_websockets.filters.all.html b/functions/_libp2p_websockets.filters.all.html index a02adaf4b4..bc83bd6688 100644 --- a/functions/_libp2p_websockets.filters.all.html +++ b/functions/_libp2p_websockets.filters.all.html @@ -1 +1 @@ -all | libp2p

    Function all

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +all | libp2p

    Function all

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_websockets.filters.dnsWsOrWss.html b/functions/_libp2p_websockets.filters.dnsWsOrWss.html index f5cc3ba920..c95bb28abb 100644 --- a/functions/_libp2p_websockets.filters.dnsWsOrWss.html +++ b/functions/_libp2p_websockets.filters.dnsWsOrWss.html @@ -1 +1 @@ -dnsWsOrWss | libp2p

    Function dnsWsOrWss

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +dnsWsOrWss | libp2p

    Function dnsWsOrWss

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_websockets.filters.dnsWss.html b/functions/_libp2p_websockets.filters.dnsWss.html index 2477f18562..bb7cd89b47 100644 --- a/functions/_libp2p_websockets.filters.dnsWss.html +++ b/functions/_libp2p_websockets.filters.dnsWss.html @@ -1 +1 @@ -dnsWss | libp2p

    Function dnsWss

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +dnsWss | libp2p

    Function dnsWss

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_websockets.filters.wss.html b/functions/_libp2p_websockets.filters.wss.html index c9850486d7..5a768c7b13 100644 --- a/functions/_libp2p_websockets.filters.wss.html +++ b/functions/_libp2p_websockets.filters.wss.html @@ -1 +1 @@ -wss | libp2p

    Function wss

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +wss | libp2p

    Function wss

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_websockets.index.webSockets.html b/functions/_libp2p_websockets.index.webSockets.html index 4b2826007a..77f8ff753f 100644 --- a/functions/_libp2p_websockets.index.webSockets.html +++ b/functions/_libp2p_websockets.index.webSockets.html @@ -1 +1 @@ -webSockets | libp2p

    Function webSockets

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +webSockets | libp2p

    Function webSockets

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_webtransport.webTransport.html b/functions/_libp2p_webtransport.webTransport.html index db0d840321..2d41e6a72b 100644 --- a/functions/_libp2p_webtransport.webTransport.html +++ b/functions/_libp2p_webtransport.webTransport.html @@ -1 +1 @@ -webTransport | libp2p

    Function webTransport

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +webTransport | libp2p

    Function webTransport

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/libp2p.index.createLibp2p.html b/functions/libp2p.index.createLibp2p.html index 2823a4dc00..76b27f09ef 100644 --- a/functions/libp2p.index.createLibp2p.html +++ b/functions/libp2p.index.createLibp2p.html @@ -3,4 +3,4 @@

    The node will be started unless start: false is passed as an option.

    Type Parameters

    Parameters

    Returns Promise<Libp2p<T>>

    Example

    import { createLibp2p } from 'libp2p'
    import { tcp } from '@libp2p/tcp'
    import { mplex } from '@libp2p/mplex'
    import { noise } from '@chainsafe/libp2p-noise'
    import { yamux } from '@chainsafe/libp2p-yamux'

    // specify options
    const options = {
      transports: [tcp()],
      streamMuxers: [yamux(), mplex()],
      connectionEncrypters: [noise()]
    }

    // create libp2p
    const libp2p = await createLibp2p(options)
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/_libp2p_auto_tls.AutoTLS.html b/interfaces/_libp2p_auto_tls.AutoTLS.html index cef9143c72..00b9b173b5 100644 --- a/interfaces/_libp2p_auto_tls.AutoTLS.html +++ b/interfaces/_libp2p_auto_tls.AutoTLS.html @@ -1,2 +1,2 @@ -AutoTLS | libp2p

    Interface AutoTLS

    interface AutoTLS {
        certificate?: TLSCertificate;
    }

    Properties

    certificate? -

    Properties

    Optional certificate

    certificate?: TLSCertificate

    Settings

    Member Visibility

    Theme

    On This Page

    certificate
    \ No newline at end of file +AutoTLS | libp2p

    Interface AutoTLS

    interface AutoTLS {
        certificate?: TLSCertificate;
    }

    Properties

    certificate? +

    Properties

    Optional certificate

    certificate?: TLSCertificate

    Settings

    Member Visibility

    Theme

    On This Page

    certificate
    \ No newline at end of file diff --git a/interfaces/_libp2p_auto_tls.AutoTLSComponents.html b/interfaces/_libp2p_auto_tls.AutoTLSComponents.html index 64f68e156a..9bede2c8e0 100644 --- a/interfaces/_libp2p_auto_tls.AutoTLSComponents.html +++ b/interfaces/_libp2p_auto_tls.AutoTLSComponents.html @@ -1,8 +1,8 @@ -AutoTLSComponents | libp2p

    Interface AutoTLSComponents

    interface AutoTLSComponents {
        addressManager: AddressManager;
        datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
        events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
        keychain: Keychain;
        logger: ComponentLogger;
        peerId: PeerId;
        privateKey: PrivateKey;
    }

    Properties

    addressManager +AutoTLSComponents | libp2p

    Interface AutoTLSComponents

    interface AutoTLSComponents {
        addressManager: AddressManager;
        datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
        events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
        keychain: Keychain;
        logger: ComponentLogger;
        peerId: PeerId;
        privateKey: PrivateKey;
    }

    Properties

    addressManager datastore events keychain logger peerId privateKey -

    Properties

    addressManager

    addressManager: AddressManager

    datastore

    datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

    Type declaration

      Type declaration

        Type declaration

          Type declaration

            Type declaration

              Type declaration

                Type declaration

                  Type declaration

                    Type declaration

                      Type declaration

                        events

                        events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                        keychain

                        keychain: Keychain

                        logger

                        logger: ComponentLogger

                        peerId

                        peerId: PeerId

                        privateKey

                        privateKey: PrivateKey

                        Settings

                        Member Visibility

                        Theme

                        On This Page

                        addressManagerdatastoreeventskeychainloggerpeerIdprivateKey
                        \ No newline at end of file +

                        Properties

                        addressManager

                        addressManager: AddressManager

                        datastore

                        datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                        Type declaration

                          Type declaration

                            Type declaration

                              Type declaration

                                Type declaration

                                  Type declaration

                                    Type declaration

                                      Type declaration

                                        Type declaration

                                          Type declaration

                                            events

                                            events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                            keychain

                                            keychain: Keychain

                                            logger

                                            logger: ComponentLogger

                                            peerId

                                            peerId: PeerId

                                            privateKey

                                            privateKey: PrivateKey

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            addressManagerdatastoreeventskeychainloggerpeerIdprivateKey
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_auto_tls.AutoTLSInit.html b/interfaces/_libp2p_auto_tls.AutoTLSInit.html index fb93f158d4..b5272a0ad3 100644 --- a/interfaces/_libp2p_auto_tls.AutoTLSInit.html +++ b/interfaces/_libp2p_auto_tls.AutoTLSInit.html @@ -1,4 +1,4 @@ -AutoTLSInit | libp2p

                                            Interface AutoTLSInit

                                            interface AutoTLSInit {
                                                accountPrivateKeyBits?: number;
                                                accountPrivateKeyName?: string;
                                                acmeDirectory?: string;
                                                autoConfirmAddress?: boolean;
                                                certificateDatastoreKey?: string;
                                                certificatePrivateKeyBits?: number;
                                                certificatePrivateKeyName?: string;
                                                forgeDomain?: string;
                                                forgeEndpoint?: string;
                                                provisionDelay?: number;
                                                provisionRequestTimeout?: number;
                                                provisionTimeout?: number;
                                                renewThreshold?: number;
                                            }

                                            Properties

                                            accountPrivateKeyBits? +AutoTLSInit | libp2p

                                            Interface AutoTLSInit

                                            interface AutoTLSInit {
                                                accountPrivateKeyBits?: number;
                                                accountPrivateKeyName?: string;
                                                acmeDirectory?: string;
                                                autoConfirmAddress?: boolean;
                                                certificateDatastoreKey?: string;
                                                certificatePrivateKeyBits?: number;
                                                certificatePrivateKeyName?: string;
                                                forgeDomain?: string;
                                                forgeEndpoint?: string;
                                                provisionDelay?: number;
                                                provisionRequestTimeout?: number;
                                                provisionTimeout?: number;
                                                renewThreshold?: number;
                                            }

                                            Properties

                                            accountPrivateKeyBits? accountPrivateKeyName? acmeDirectory? autoConfirmAddress? @@ -14,10 +14,10 @@

                                            Properties

                                            Optional accountPrivateKeyBits

                                            accountPrivateKeyBits?: number

                                            How many bits the RSA private key for the account should be

                                            Default

                                            2048
                                            -

                                            Optional accountPrivateKeyName

                                            accountPrivateKeyName?: string

                                            The name the ACME account RSA private key is stored in the keychain with

                                            +

                                            Optional accountPrivateKeyName

                                            accountPrivateKeyName?: string

                                            The name the ACME account RSA private key is stored in the keychain with

                                            Default

                                            'auto-tls-acme-account-private-key'
                                            -

                                            Optional acmeDirectory

                                            acmeDirectory?: string

                                            Which ACME service to use - examples are:

                                            +

                                            Optional acmeDirectory

                                            acmeDirectory?: string

                                            Which ACME service to use - examples are:

                                            Default

                                            'https://acme-v02.api.letsencrypt.org/directory'
                                            -

                                            Optional autoConfirmAddress

                                            autoConfirmAddress?: boolean

                                            Any mapped addresses are added to the observed address list. These +

                                            Optional autoConfirmAddress

                                            autoConfirmAddress?: boolean

                                            Any mapped addresses are added to the observed address list. These addresses require additional verification by the @libp2p/autonat protocol or similar before they are trusted.

                                            To skip this verification and trust them immediately pass true here

                                            Default

                                            false
                                            -

                                            Optional certificateDatastoreKey

                                            certificateDatastoreKey?: string

                                            The key the certificate is stored in the datastore under

                                            +

                                            Optional certificateDatastoreKey

                                            certificateDatastoreKey?: string

                                            The key the certificate is stored in the datastore under

                                            Default

                                            '/libp2p/auto-tls/certificate'
                                            -

                                            Optional certificatePrivateKeyBits

                                            certificatePrivateKeyBits?: number

                                            How many bits the RSA private key for the certificate should be

                                            +

                                            Optional certificatePrivateKeyBits

                                            certificatePrivateKeyBits?: number

                                            How many bits the RSA private key for the certificate should be

                                            Default

                                            2048
                                            -

                                            Optional certificatePrivateKeyName

                                            certificatePrivateKeyName?: string

                                            The name the certificate RSA private key is stored in the keychain with

                                            +

                                            Optional certificatePrivateKeyName

                                            certificatePrivateKeyName?: string

                                            The name the certificate RSA private key is stored in the keychain with

                                            Default

                                            'auto-tls-certificate-private-key'
                                            -

                                            Optional forgeDomain

                                            forgeDomain?: string

                                            The top level domain under which we will request certificate for

                                            +

                                            Optional forgeDomain

                                            forgeDomain?: string

                                            The top level domain under which we will request certificate for

                                            Default

                                            'libp2p.direct'
                                            -

                                            Optional forgeEndpoint

                                            forgeEndpoint?: string

                                            Where to send requests to answer an ACME DNS challenge on our behalf - note +

                                            Optional forgeEndpoint

                                            forgeEndpoint?: string

                                            Where to send requests to answer an ACME DNS challenge on our behalf - note that /v1/_acme-challenge will be added to the end of the URL

                                            Default

                                            'https://registration.libp2p.direct'
                                            -

                                            Optional provisionDelay

                                            provisionDelay?: number

                                            Certificates are acquired when the self:peer:update event fires, which +

                                            Optional provisionDelay

                                            provisionDelay?: number

                                            Certificates are acquired when the self:peer:update event fires, which happens when the node's addresses change. To avoid starting to map ports while multiple addresses are being added, the mapping function is debounced by this number of ms

                                            Default

                                            5000
                                            -

                                            Optional provisionRequestTimeout

                                            provisionRequestTimeout?: number

                                            How long asking the forge endpoint to answer a DNS challenge can take +

                                            Optional provisionRequestTimeout

                                            provisionRequestTimeout?: number

                                            How long asking the forge endpoint to answer a DNS challenge can take before we retry

                                            Default

                                            60_000
                                            -

                                            Optional provisionTimeout

                                            provisionTimeout?: number

                                            How long to attempt to acquire a certificate before timing out in ms

                                            +

                                            Optional provisionTimeout

                                            provisionTimeout?: number

                                            How long to attempt to acquire a certificate before timing out in ms

                                            Default

                                            120_000
                                            -

                                            Optional renewThreshold

                                            renewThreshold?: number

                                            How long before the expiry of the certificate to renew it in ms, defaults +

                                            Optional renewThreshold

                                            renewThreshold?: number

                                            How long before the expiry of the certificate to renew it in ms, defaults to one day

                                            Default

                                            86_400_000
                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            accountPrivateKeyBitsaccountPrivateKeyNameacmeDirectoryautoConfirmAddresscertificateDatastoreKeycertificatePrivateKeyBitscertificatePrivateKeyNameforgeDomainforgeEndpointprovisionDelayprovisionRequestTimeoutprovisionTimeoutrenewThreshold
                                            \ No newline at end of file +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            accountPrivateKeyBitsaccountPrivateKeyNameacmeDirectoryautoConfirmAddresscertificateDatastoreKeycertificatePrivateKeyBitscertificatePrivateKeyNameforgeDomainforgeEndpointprovisionDelayprovisionRequestTimeoutprovisionTimeoutrenewThreshold
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_autonat.AutoNATComponents.html b/interfaces/_libp2p_autonat.AutoNATComponents.html index ecc348b67e..7c44541953 100644 --- a/interfaces/_libp2p_autonat.AutoNATComponents.html +++ b/interfaces/_libp2p_autonat.AutoNATComponents.html @@ -1,4 +1,4 @@ -AutoNATComponents | libp2p

                                            Interface AutoNATComponents

                                            interface AutoNATComponents {
                                                addressManager: AddressManager;
                                                connectionManager: ConnectionManager;
                                                events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                logger: ComponentLogger;
                                                peerId: PeerId;
                                                peerStore: PeerStore;
                                                randomWalk: RandomWalk;
                                                registrar: Registrar;
                                                transportManager: TransportManager;
                                            }

                                            Properties

                                            addressManager +AutoNATComponents | libp2p

                                            Interface AutoNATComponents

                                            interface AutoNATComponents {
                                                addressManager: AddressManager;
                                                connectionManager: ConnectionManager;
                                                events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                logger: ComponentLogger;
                                                peerId: PeerId;
                                                peerStore: PeerStore;
                                                randomWalk: RandomWalk;
                                                registrar: Registrar;
                                                transportManager: TransportManager;
                                            }

                                            Properties

                                            addressManager connectionManager events logger @@ -7,4 +7,4 @@ randomWalk registrar transportManager -

                                            Properties

                                            addressManager

                                            addressManager: AddressManager

                                            connectionManager

                                            connectionManager: ConnectionManager

                                            events

                                            events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                            logger

                                            logger: ComponentLogger

                                            peerId

                                            peerId: PeerId

                                            peerStore

                                            peerStore: PeerStore

                                            randomWalk

                                            randomWalk: RandomWalk

                                            registrar

                                            registrar: Registrar

                                            transportManager

                                            transportManager: TransportManager

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            addressManagerconnectionManagereventsloggerpeerIdpeerStorerandomWalkregistrartransportManager
                                            \ No newline at end of file +

                                            Properties

                                            addressManager

                                            addressManager: AddressManager

                                            connectionManager

                                            connectionManager: ConnectionManager

                                            events

                                            events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                            logger

                                            logger: ComponentLogger

                                            peerId

                                            peerId: PeerId

                                            peerStore

                                            peerStore: PeerStore

                                            randomWalk

                                            randomWalk: RandomWalk

                                            registrar

                                            registrar: Registrar

                                            transportManager

                                            transportManager: TransportManager

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            addressManagerconnectionManagereventsloggerpeerIdpeerStorerandomWalkregistrartransportManager
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_autonat.AutoNATServiceInit.html b/interfaces/_libp2p_autonat.AutoNATServiceInit.html index f3ce6aea2a..5784578b61 100644 --- a/interfaces/_libp2p_autonat.AutoNATServiceInit.html +++ b/interfaces/_libp2p_autonat.AutoNATServiceInit.html @@ -1,4 +1,4 @@ -AutoNATServiceInit | libp2p

                                            Interface AutoNATServiceInit

                                            interface AutoNATServiceInit {
                                                connectionThreshold?: number;
                                                maxInboundStreams?: number;
                                                maxMessageSize?: number;
                                                maxOutboundStreams?: number;
                                                protocolPrefix?: string;
                                                refreshInterval?: number;
                                                startupDelay?: number;
                                                timeout?: number;
                                            }

                                            Properties

                                            connectionThreshold? +AutoNATServiceInit | libp2p

                                            Interface AutoNATServiceInit

                                            interface AutoNATServiceInit {
                                                connectionThreshold?: number;
                                                maxInboundStreams?: number;
                                                maxMessageSize?: number;
                                                maxOutboundStreams?: number;
                                                protocolPrefix?: string;
                                                refreshInterval?: number;
                                                startupDelay?: number;
                                                timeout?: number;
                                            }

                                            Properties

                                            connectionThreshold? maxInboundStreams? maxMessageSize? maxOutboundStreams? @@ -13,14 +13,14 @@ node to delist it.

                                            Default

                                            80
                                            -

                                            Optional maxInboundStreams

                                            maxInboundStreams?: number

                                            How many parallel inbound autoNAT streams we allow per-connection

                                            -

                                            Optional maxMessageSize

                                            maxMessageSize?: number

                                            How large incoming autonat messages are allowed to be in bytes. If messages +

                                            Optional maxInboundStreams

                                            maxInboundStreams?: number

                                            How many parallel inbound autoNAT streams we allow per-connection

                                            +

                                            Optional maxMessageSize

                                            maxMessageSize?: number

                                            How large incoming autonat messages are allowed to be in bytes. If messages larger than this are received the stream will be reset.

                                            Default

                                            8192
                                            -

                                            Optional maxOutboundStreams

                                            maxOutboundStreams?: number

                                            How many parallel outbound autoNAT streams we allow per-connection

                                            -

                                            Optional protocolPrefix

                                            protocolPrefix?: string

                                            Allows overriding the protocol prefix used

                                            -

                                            Optional refreshInterval

                                            refreshInterval?: number

                                            Verify our external addresses this often

                                            -

                                            Optional startupDelay

                                            startupDelay?: number

                                            How long to wait after startup before trying to verify our external address

                                            -

                                            Optional timeout

                                            timeout?: number

                                            How long we should wait for a remote peer to verify our external address

                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            connectionThresholdmaxInboundStreamsmaxMessageSizemaxOutboundStreamsprotocolPrefixrefreshIntervalstartupDelaytimeout
                                            \ No newline at end of file +

                                            Optional maxOutboundStreams

                                            maxOutboundStreams?: number

                                            How many parallel outbound autoNAT streams we allow per-connection

                                            +

                                            Optional protocolPrefix

                                            protocolPrefix?: string

                                            Allows overriding the protocol prefix used

                                            +

                                            Optional refreshInterval

                                            refreshInterval?: number

                                            Verify our external addresses this often

                                            +

                                            Optional startupDelay

                                            startupDelay?: number

                                            How long to wait after startup before trying to verify our external address

                                            +

                                            Optional timeout

                                            timeout?: number

                                            How long we should wait for a remote peer to verify our external address

                                            +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            connectionThresholdmaxInboundStreamsmaxMessageSizemaxOutboundStreamsprotocolPrefixrefreshIntervalstartupDelaytimeout
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_bootstrap.BootstrapComponents.html b/interfaces/_libp2p_bootstrap.BootstrapComponents.html index 9cd34bbee5..284cb051a1 100644 --- a/interfaces/_libp2p_bootstrap.BootstrapComponents.html +++ b/interfaces/_libp2p_bootstrap.BootstrapComponents.html @@ -1,4 +1,4 @@ -BootstrapComponents | libp2p

                                            Interface BootstrapComponents

                                            interface BootstrapComponents {
                                                connectionManager: ConnectionManager;
                                                logger: ComponentLogger;
                                                peerStore: PeerStore;
                                            }

                                            Properties

                                            connectionManager +BootstrapComponents | libp2p

                                            Interface BootstrapComponents

                                            interface BootstrapComponents {
                                                connectionManager: ConnectionManager;
                                                logger: ComponentLogger;
                                                peerStore: PeerStore;
                                            }

                                            Properties

                                            connectionManager logger peerStore -

                                            Properties

                                            connectionManager

                                            connectionManager: ConnectionManager

                                            logger

                                            logger: ComponentLogger

                                            peerStore

                                            peerStore: PeerStore

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            connectionManagerloggerpeerStore
                                            \ No newline at end of file +

                                            Properties

                                            connectionManager

                                            connectionManager: ConnectionManager

                                            logger

                                            logger: ComponentLogger

                                            peerStore

                                            peerStore: PeerStore

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            connectionManagerloggerpeerStore
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_bootstrap.BootstrapInit.html b/interfaces/_libp2p_bootstrap.BootstrapInit.html index ed8d8cc27c..08080b6298 100644 --- a/interfaces/_libp2p_bootstrap.BootstrapInit.html +++ b/interfaces/_libp2p_bootstrap.BootstrapInit.html @@ -1,15 +1,15 @@ -BootstrapInit | libp2p

                                            Interface BootstrapInit

                                            interface BootstrapInit {
                                                list: string[];
                                                tagName?: string;
                                                tagTTL?: number;
                                                tagValue?: number;
                                                timeout?: number;
                                            }

                                            Properties

                                            list +BootstrapInit | libp2p

                                            Interface BootstrapInit

                                            interface BootstrapInit {
                                                list: string[];
                                                tagName?: string;
                                                tagTTL?: number;
                                                tagValue?: number;
                                                timeout?: number;
                                            }

                                            Properties

                                            list tagName? tagTTL? tagValue? timeout?

                                            Properties

                                            list

                                            list: string[]

                                            The list of peer addresses in multi-address format

                                            -

                                            Optional tagName

                                            tagName?: string

                                            Tag a bootstrap peer with this name before "discovering" it

                                            +

                                            Optional tagName

                                            tagName?: string

                                            Tag a bootstrap peer with this name before "discovering" it

                                            Default

                                            'bootstrap'
                                            -

                                            Optional tagTTL

                                            tagTTL?: number

                                            Cause the bootstrap peer tag to be removed after this number of ms

                                            -

                                            Optional tagValue

                                            tagValue?: number

                                            The bootstrap peer tag will have this value

                                            +

                                            Optional tagTTL

                                            tagTTL?: number

                                            Cause the bootstrap peer tag to be removed after this number of ms

                                            +

                                            Optional tagValue

                                            tagValue?: number

                                            The bootstrap peer tag will have this value

                                            Default

                                            50
                                            -

                                            Optional timeout

                                            timeout?: number

                                            How long to wait before discovering bootstrap nodes

                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            listtagNametagTTLtagValuetimeout
                                            \ No newline at end of file +

                                            Optional timeout

                                            timeout?: number

                                            How long to wait before discovering bootstrap nodes

                                            +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            listtagNametagTTLtagValuetimeout
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_circuit_relay_v2.CircuitRelayServerComponents.html b/interfaces/_libp2p_circuit_relay_v2.CircuitRelayServerComponents.html index 95ba0bae82..a5f5fc8e91 100644 --- a/interfaces/_libp2p_circuit_relay_v2.CircuitRelayServerComponents.html +++ b/interfaces/_libp2p_circuit_relay_v2.CircuitRelayServerComponents.html @@ -1,4 +1,4 @@ -CircuitRelayServerComponents | libp2p

                                            Interface CircuitRelayServerComponents

                                            interface CircuitRelayServerComponents {
                                                addressManager: AddressManager;
                                                connectionGater: ConnectionGater;
                                                connectionManager: ConnectionManager;
                                                logger: ComponentLogger;
                                                metrics?: Metrics;
                                                peerId: PeerId;
                                                peerStore: PeerStore;
                                                privateKey: PrivateKey;
                                                registrar: Registrar;
                                            }

                                            Properties

                                            addressManager +CircuitRelayServerComponents | libp2p

                                            Interface CircuitRelayServerComponents

                                            interface CircuitRelayServerComponents {
                                                addressManager: AddressManager;
                                                connectionGater: ConnectionGater;
                                                connectionManager: ConnectionManager;
                                                logger: ComponentLogger;
                                                metrics?: Metrics;
                                                peerId: PeerId;
                                                peerStore: PeerStore;
                                                privateKey: PrivateKey;
                                                registrar: Registrar;
                                            }

                                            Properties

                                            addressManager connectionGater connectionManager logger @@ -7,4 +7,4 @@ peerStore privateKey registrar -

                                            Properties

                                            addressManager

                                            addressManager: AddressManager

                                            connectionGater

                                            connectionGater: ConnectionGater

                                            connectionManager

                                            connectionManager: ConnectionManager

                                            logger

                                            logger: ComponentLogger

                                            Optional metrics

                                            metrics?: Metrics

                                            peerId

                                            peerId: PeerId

                                            peerStore

                                            peerStore: PeerStore

                                            privateKey

                                            privateKey: PrivateKey

                                            registrar

                                            registrar: Registrar

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            addressManagerconnectionGaterconnectionManagerloggermetricspeerIdpeerStoreprivateKeyregistrar
                                            \ No newline at end of file +

                                            Properties

                                            addressManager

                                            addressManager: AddressManager

                                            connectionGater

                                            connectionGater: ConnectionGater

                                            connectionManager

                                            connectionManager: ConnectionManager

                                            logger

                                            logger: ComponentLogger

                                            Optional metrics

                                            metrics?: Metrics

                                            peerId

                                            peerId: PeerId

                                            peerStore

                                            peerStore: PeerStore

                                            privateKey

                                            privateKey: PrivateKey

                                            registrar

                                            registrar: Registrar

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            addressManagerconnectionGaterconnectionManagerloggermetricspeerIdpeerStoreprivateKeyregistrar
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_circuit_relay_v2.CircuitRelayServerInit.html b/interfaces/_libp2p_circuit_relay_v2.CircuitRelayServerInit.html index d8977eea35..e451aaaf81 100644 --- a/interfaces/_libp2p_circuit_relay_v2.CircuitRelayServerInit.html +++ b/interfaces/_libp2p_circuit_relay_v2.CircuitRelayServerInit.html @@ -1,4 +1,4 @@ -CircuitRelayServerInit | libp2p

                                            Interface CircuitRelayServerInit

                                            interface CircuitRelayServerInit {
                                                hopTimeout?: number;
                                                maxInboundHopStreams?: number;
                                                maxOutboundHopStreams?: number;
                                                maxOutboundStopStreams?: number;
                                                reservations?: ServerReservationStoreInit;
                                            }

                                            Properties

                                            hopTimeout? +CircuitRelayServerInit | libp2p

                                            Interface CircuitRelayServerInit

                                            interface CircuitRelayServerInit {
                                                hopTimeout?: number;
                                                maxInboundHopStreams?: number;
                                                maxOutboundHopStreams?: number;
                                                maxOutboundStopStreams?: number;
                                                reservations?: ServerReservationStoreInit;
                                            }

                                            Properties

                                            hopTimeout? maxInboundHopStreams? maxOutboundHopStreams? maxOutboundStopStreams? @@ -7,11 +7,11 @@ the stream will be reset

                                            Default

                                            30000
                                            -

                                            Optional maxInboundHopStreams

                                            maxInboundHopStreams?: number

                                            The maximum number of simultaneous HOP inbound streams that can be open at once

                                            -

                                            Optional maxOutboundHopStreams

                                            maxOutboundHopStreams?: number

                                            The maximum number of simultaneous HOP outbound streams that can be open at once

                                            -

                                            Optional maxOutboundStopStreams

                                            maxOutboundStopStreams?: number

                                            The maximum number of simultaneous STOP outbound streams that can be open at +

                                            Optional maxInboundHopStreams

                                            maxInboundHopStreams?: number

                                            The maximum number of simultaneous HOP inbound streams that can be open at once

                                            +

                                            Optional maxOutboundHopStreams

                                            maxOutboundHopStreams?: number

                                            The maximum number of simultaneous HOP outbound streams that can be open at once

                                            +

                                            Optional maxOutboundStopStreams

                                            maxOutboundStopStreams?: number

                                            The maximum number of simultaneous STOP outbound streams that can be open at once.

                                            Default

                                            300
                                            -

                                            Optional reservations

                                            reservations?: ServerReservationStoreInit

                                            Configuration of reservations

                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            hopTimeoutmaxInboundHopStreamsmaxOutboundHopStreamsmaxOutboundStopStreamsreservations
                                            \ No newline at end of file +

                                            Optional reservations

                                            reservations?: ServerReservationStoreInit

                                            Configuration of reservations

                                            +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            hopTimeoutmaxInboundHopStreamsmaxOutboundHopStreamsmaxOutboundStopStreamsreservations
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_circuit_relay_v2.CircuitRelayService.html b/interfaces/_libp2p_circuit_relay_v2.CircuitRelayService.html index c69e3b062d..c5a09bd06b 100644 --- a/interfaces/_libp2p_circuit_relay_v2.CircuitRelayService.html +++ b/interfaces/_libp2p_circuit_relay_v2.CircuitRelayService.html @@ -1,12 +1,12 @@ CircuitRelayService | libp2p

                                            Interface CircuitRelayService

                                            An implementation of a typed event target etc

                                            -
                                            interface CircuitRelayService {
                                                #private: any;
                                                reservations: PeerMap<RelayReservation>;
                                                addEventListener<K>(type, listener, options?): void;
                                                dispatchEvent(event): boolean;
                                                listenerCount(type): number;
                                                removeEventListener<K>(type, listener?, options?): void;
                                                safeDispatchEvent<Detail>(type, detail?): boolean;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            #private +
                                            interface CircuitRelayService {
                                                #private: any;
                                                reservations: PeerMap<RelayReservation>;
                                                addEventListener<K>(type, listener, options?): void;
                                                dispatchEvent(event): boolean;
                                                listenerCount(type): number;
                                                removeEventListener<K>(type, listener?, options?): void;
                                                safeDispatchEvent<Detail>(type, detail?): boolean;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            #private reservations

                                            Methods

                                            addEventListener dispatchEvent listenerCount removeEventListener safeDispatchEvent -

                                            Properties

                                            Private #private

                                            #private: any

                                            reservations

                                            reservations: PeerMap<RelayReservation>

                                            Methods

                                            addEventListener

                                            dispatchEvent

                                            • dispatchEvent(event): boolean

                                            • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                              +

                                            Properties

                                            Private #private

                                            #private: any

                                            reservations

                                            reservations: PeerMap<RelayReservation>

                                            Methods

                                            addEventListener

                                            dispatchEvent

                                            • dispatchEvent(event): boolean

                                            • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                              MDN Reference

                                              Parameters

                                              Returns boolean

                                            listenerCount

                                            • listenerCount(type): number

                                            • Parameters

                                              • type: string

                                              Returns number

                                            removeEventListener

                                            safeDispatchEvent

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            #privatereservationsaddEventListenerdispatchEventlistenerCountremoveEventListenersafeDispatchEvent
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_circuit_relay_v2.CircuitRelayServiceEvents.html b/interfaces/_libp2p_circuit_relay_v2.CircuitRelayServiceEvents.html index 1692a755f0..b3d4c3429e 100644 --- a/interfaces/_libp2p_circuit_relay_v2.CircuitRelayServiceEvents.html +++ b/interfaces/_libp2p_circuit_relay_v2.CircuitRelayServiceEvents.html @@ -1,4 +1,4 @@ -CircuitRelayServiceEvents | libp2p

                                            Interface CircuitRelayServiceEvents

                                            interface CircuitRelayServiceEvents {
                                                relay:advert:error: CustomEvent<Error>;
                                                relay:advert:success: CustomEvent<unknown>;
                                                relay:reservation: CustomEvent<RelayReservation>;
                                            }

                                            Properties

                                            relay:advert:error +CircuitRelayServiceEvents | libp2p

                                            Interface CircuitRelayServiceEvents

                                            interface CircuitRelayServiceEvents {
                                                relay:advert:error: CustomEvent<Error>;
                                                relay:advert:success: CustomEvent<unknown>;
                                                relay:reservation: CustomEvent<RelayReservation>;
                                            }

                                            Properties

                                            relay:advert:error relay:advert:success relay:reservation -

                                            Properties

                                            relay:advert:error

                                            relay:advert:error: CustomEvent<Error>

                                            relay:advert:success

                                            relay:advert:success: CustomEvent<unknown>

                                            relay:reservation

                                            relay:reservation: CustomEvent<RelayReservation>

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            relay:advert:errorrelay:advert:successrelay:reservation
                                            \ No newline at end of file +

                                            Properties

                                            relay:advert:error

                                            relay:advert:error: CustomEvent<Error>

                                            relay:advert:success

                                            relay:advert:success: CustomEvent<unknown>

                                            relay:reservation

                                            relay:reservation: CustomEvent<RelayReservation>

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            relay:advert:errorrelay:advert:successrelay:reservation
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_circuit_relay_v2.CircuitRelayTransportComponents.html b/interfaces/_libp2p_circuit_relay_v2.CircuitRelayTransportComponents.html index 5991e0a770..985920be97 100644 --- a/interfaces/_libp2p_circuit_relay_v2.CircuitRelayTransportComponents.html +++ b/interfaces/_libp2p_circuit_relay_v2.CircuitRelayTransportComponents.html @@ -1,4 +1,4 @@ -CircuitRelayTransportComponents | libp2p

                                            Interface CircuitRelayTransportComponents

                                            interface CircuitRelayTransportComponents {
                                                addressManager: AddressManager;
                                                connectionGater: ConnectionGater;
                                                connectionManager: ConnectionManager;
                                                events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                logger: ComponentLogger;
                                                peerId: PeerId;
                                                peerStore: PeerStore;
                                                randomWalk: RandomWalk;
                                                registrar: Registrar;
                                                transportManager: TransportManager;
                                                upgrader: Upgrader;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            addressManager +CircuitRelayTransportComponents | libp2p

                                            Interface CircuitRelayTransportComponents

                                            interface CircuitRelayTransportComponents {
                                                addressManager: AddressManager;
                                                connectionGater: ConnectionGater;
                                                connectionManager: ConnectionManager;
                                                events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                logger: ComponentLogger;
                                                peerId: PeerId;
                                                peerStore: PeerStore;
                                                randomWalk: RandomWalk;
                                                registrar: Registrar;
                                                transportManager: TransportManager;
                                                upgrader: Upgrader;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            addressManager connectionGater connectionManager events @@ -9,4 +9,4 @@ registrar transportManager upgrader -

                                            Properties

                                            addressManager

                                            addressManager: AddressManager

                                            connectionGater

                                            connectionGater: ConnectionGater

                                            connectionManager

                                            connectionManager: ConnectionManager

                                            events

                                            events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                            logger

                                            logger: ComponentLogger

                                            peerId

                                            peerId: PeerId

                                            peerStore

                                            peerStore: PeerStore

                                            randomWalk

                                            randomWalk: RandomWalk

                                            registrar

                                            registrar: Registrar

                                            transportManager

                                            transportManager: TransportManager

                                            upgrader

                                            upgrader: Upgrader

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            addressManagerconnectionGaterconnectionManagereventsloggerpeerIdpeerStorerandomWalkregistrartransportManagerupgrader
                                            \ No newline at end of file +

                                            Properties

                                            addressManager

                                            addressManager: AddressManager

                                            connectionGater

                                            connectionGater: ConnectionGater

                                            connectionManager

                                            connectionManager: ConnectionManager

                                            events

                                            events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                            logger

                                            logger: ComponentLogger

                                            peerId

                                            peerId: PeerId

                                            peerStore

                                            peerStore: PeerStore

                                            randomWalk

                                            randomWalk: RandomWalk

                                            registrar

                                            registrar: Registrar

                                            transportManager

                                            transportManager: TransportManager

                                            upgrader

                                            upgrader: Upgrader

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            addressManagerconnectionGaterconnectionManagereventsloggerpeerIdpeerStorerandomWalkregistrartransportManagerupgrader
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_circuit_relay_v2.CircuitRelayTransportInit.html b/interfaces/_libp2p_circuit_relay_v2.CircuitRelayTransportInit.html index 2b4e41061d..6867aebba9 100644 --- a/interfaces/_libp2p_circuit_relay_v2.CircuitRelayTransportInit.html +++ b/interfaces/_libp2p_circuit_relay_v2.CircuitRelayTransportInit.html @@ -1,5 +1,5 @@ CircuitRelayTransportInit | libp2p

                                            Interface CircuitRelayTransportInit

                                            RelayConfig configures the circuit v2 relay transport.

                                            -
                                            interface CircuitRelayTransportInit {
                                                discoveryFilter?: TopologyFilter;
                                                maxInboundStopStreams?: number;
                                                maxOutboundStopStreams?: number;
                                                maxReservationQueueLength?: number;
                                                reservationCompletionTimeout?: number;
                                                reservationConcurrency?: number;
                                                stopTimeout?: number;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            discoveryFilter? +
                                            interface CircuitRelayTransportInit {
                                                discoveryFilter?: TopologyFilter;
                                                maxInboundStopStreams?: number;
                                                maxOutboundStopStreams?: number;
                                                maxReservationQueueLength?: number;
                                                reservationCompletionTimeout?: number;
                                                reservationConcurrency?: number;
                                                stopTimeout?: number;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            discoveryFilter? maxInboundStopStreams? maxOutboundStopStreams? maxReservationQueueLength? @@ -8,22 +8,22 @@ stopTimeout?

                                            Properties

                                            Optional discoveryFilter

                                            discoveryFilter?: TopologyFilter

                                            An optional filter used to prevent duplicate attempts to reserve relay slots on the same peer

                                            -

                                            Optional maxInboundStopStreams

                                            maxInboundStopStreams?: number

                                            The maximum number of simultaneous STOP inbound streams that can be open at +

                                            Optional maxInboundStopStreams

                                            maxInboundStopStreams?: number

                                            The maximum number of simultaneous STOP inbound streams that can be open at once - each inbound relayed connection uses a STOP stream

                                            Default

                                            300
                                            -

                                            Optional maxOutboundStopStreams

                                            maxOutboundStopStreams?: number

                                            The maximum number of simultaneous STOP outbound streams that can be open +

                                            Optional maxOutboundStopStreams

                                            maxOutboundStopStreams?: number

                                            The maximum number of simultaneous STOP outbound streams that can be open at once. If this transport is used along with the relay server these settings should be set to the same value

                                            Default

                                            300
                                            -

                                            Optional maxReservationQueueLength

                                            maxReservationQueueLength?: number

                                            Limit the number of potential relays we will dial

                                            +

                                            Optional maxReservationQueueLength

                                            maxReservationQueueLength?: number

                                            Limit the number of potential relays we will dial

                                            Default

                                            100
                                            -

                                            Optional reservationCompletionTimeout

                                            reservationCompletionTimeout?: number

                                            When creating a reservation it must complete within this number of ms

                                            +

                                            Optional reservationCompletionTimeout

                                            reservationCompletionTimeout?: number

                                            When creating a reservation it must complete within this number of ms

                                            Default

                                            10000
                                            -

                                            Optional reservationConcurrency

                                            reservationConcurrency?: number

                                            Multiple relays may be discovered simultaneously - to prevent listening +

                                            Optional reservationConcurrency

                                            reservationConcurrency?: number

                                            Multiple relays may be discovered simultaneously - to prevent listening on too many relays, this value controls how many to attempt to reserve a slot on at once. If set to more than one, we may end up listening on more relays than the maxReservations value, but on networks with poor @@ -31,9 +31,9 @@ simultaneously.

                                            Default

                                            1
                                            -

                                            Optional stopTimeout

                                            stopTimeout?: number

                                            Incoming STOP requests (e.g. when a remote peer wants to dial us via a +

                                            Optional stopTimeout

                                            stopTimeout?: number

                                            Incoming STOP requests (e.g. when a remote peer wants to dial us via a relay) must finish the initial protocol negotiation within this timeout in ms

                                            Default

                                            30000
                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            discoveryFiltermaxInboundStopStreamsmaxOutboundStopStreamsmaxReservationQueueLengthreservationCompletionTimeoutreservationConcurrencystopTimeout
                                            \ No newline at end of file +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            discoveryFiltermaxInboundStopStreamsmaxOutboundStopStreamsmaxReservationQueueLengthreservationCompletionTimeoutreservationConcurrencystopTimeout
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_circuit_relay_v2.Limit-1.html b/interfaces/_libp2p_circuit_relay_v2.Limit-1.html index fc5e38453d..d00236fc34 100644 --- a/interfaces/_libp2p_circuit_relay_v2.Limit-1.html +++ b/interfaces/_libp2p_circuit_relay_v2.Limit-1.html @@ -1,3 +1,3 @@ -Limit | libp2p

                                            Interface Limit

                                            interface Limit {
                                                data?: bigint;
                                                duration?: number;
                                            }

                                            Properties

                                            data? +Limit | libp2p

                                            Interface Limit

                                            interface Limit {
                                                data?: bigint;
                                                duration?: number;
                                            }

                                            Properties

                                            data? duration? -

                                            Properties

                                            Optional data

                                            data?: bigint

                                            Optional duration

                                            duration?: number

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            dataduration
                                            \ No newline at end of file +

                                            Properties

                                            Optional data

                                            data?: bigint

                                            Optional duration

                                            duration?: number

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            dataduration
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_circuit_relay_v2.RelayDiscoveryComponents.html b/interfaces/_libp2p_circuit_relay_v2.RelayDiscoveryComponents.html index 9db554effe..1f13a5c41b 100644 --- a/interfaces/_libp2p_circuit_relay_v2.RelayDiscoveryComponents.html +++ b/interfaces/_libp2p_circuit_relay_v2.RelayDiscoveryComponents.html @@ -1,7 +1,7 @@ -RelayDiscoveryComponents | libp2p

                                            Interface RelayDiscoveryComponents

                                            interface RelayDiscoveryComponents {
                                                connectionManager: ConnectionManager;
                                                logger: ComponentLogger;
                                                peerStore: PeerStore;
                                                randomWalk: RandomWalk;
                                                registrar: Registrar;
                                                transportManager: TransportManager;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            connectionManager +RelayDiscoveryComponents | libp2p

                                            Interface RelayDiscoveryComponents

                                            interface RelayDiscoveryComponents {
                                                connectionManager: ConnectionManager;
                                                logger: ComponentLogger;
                                                peerStore: PeerStore;
                                                randomWalk: RandomWalk;
                                                registrar: Registrar;
                                                transportManager: TransportManager;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            connectionManager logger peerStore randomWalk registrar transportManager -

                                            Properties

                                            connectionManager

                                            connectionManager: ConnectionManager

                                            logger

                                            logger: ComponentLogger

                                            peerStore

                                            peerStore: PeerStore

                                            randomWalk

                                            randomWalk: RandomWalk

                                            registrar

                                            registrar: Registrar

                                            transportManager

                                            transportManager: TransportManager

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            connectionManagerloggerpeerStorerandomWalkregistrartransportManager
                                            \ No newline at end of file +

                                            Properties

                                            connectionManager

                                            connectionManager: ConnectionManager

                                            logger

                                            logger: ComponentLogger

                                            peerStore

                                            peerStore: PeerStore

                                            randomWalk

                                            randomWalk: RandomWalk

                                            registrar

                                            registrar: Registrar

                                            transportManager

                                            transportManager: TransportManager

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            connectionManagerloggerpeerStorerandomWalkregistrartransportManager
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_circuit_relay_v2.RelayReservation.html b/interfaces/_libp2p_circuit_relay_v2.RelayReservation.html index 51cbd0e1c0..8e30bef5b5 100644 --- a/interfaces/_libp2p_circuit_relay_v2.RelayReservation.html +++ b/interfaces/_libp2p_circuit_relay_v2.RelayReservation.html @@ -1,10 +1,10 @@ -RelayReservation | libp2p

                                            Interface RelayReservation

                                            interface RelayReservation {
                                                addr: Multiaddr;
                                                expiry: Date;
                                                limit?: Limit;
                                                signal: RetimeableAbortSignal;
                                            }

                                            Properties

                                            addr +RelayReservation | libp2p

                                            Interface RelayReservation

                                            interface RelayReservation {
                                                addr: Multiaddr;
                                                expiry: Date;
                                                limit?: Limit;
                                                signal: RetimeableAbortSignal;
                                            }

                                            Properties

                                            addr expiry limit? signal

                                            Properties

                                            addr

                                            addr: Multiaddr

                                            The address of the relay client

                                            -

                                            expiry

                                            expiry: Date

                                            When this reservation expires

                                            -

                                            Optional limit

                                            limit?: Limit

                                            How much data can be transferred over each relayed connection and for how +

                                            expiry

                                            expiry: Date

                                            When this reservation expires

                                            +

                                            Optional limit

                                            limit?: Limit

                                            How much data can be transferred over each relayed connection and for how long before the underlying stream is reset

                                            -

                                            signal

                                            signal: RetimeableAbortSignal

                                            This signal will fire it's "abort" event when the reservation expires

                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            addrexpirylimitsignal
                                            \ No newline at end of file +

                                            signal

                                            signal: RetimeableAbortSignal

                                            This signal will fire it's "abort" event when the reservation expires

                                            +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            addrexpirylimitsignal
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_circuit_relay_v2.ServerReservationStoreInit.html b/interfaces/_libp2p_circuit_relay_v2.ServerReservationStoreInit.html index 7232b5c197..a41e8b9d90 100644 --- a/interfaces/_libp2p_circuit_relay_v2.ServerReservationStoreInit.html +++ b/interfaces/_libp2p_circuit_relay_v2.ServerReservationStoreInit.html @@ -1,4 +1,4 @@ -ServerReservationStoreInit | libp2p

                                            Interface ServerReservationStoreInit

                                            interface ServerReservationStoreInit {
                                                applyDefaultLimit?: boolean;
                                                defaultDataLimit?: bigint;
                                                defaultDurationLimit?: number;
                                                maxReservations?: number;
                                                reservationClearInterval?: number;
                                                reservationTtl?: number;
                                            }

                                            Properties

                                            applyDefaultLimit? +ServerReservationStoreInit | libp2p

                                            Interface ServerReservationStoreInit

                                            interface ServerReservationStoreInit {
                                                applyDefaultLimit?: boolean;
                                                defaultDataLimit?: bigint;
                                                defaultDurationLimit?: number;
                                                maxReservations?: number;
                                                reservationClearInterval?: number;
                                                reservationTtl?: number;
                                            }

                                            Properties

                                            applyDefaultLimit? defaultDataLimit? defaultDurationLimit? maxReservations? @@ -7,15 +7,15 @@

                                            Properties

                                            Optional applyDefaultLimit

                                            applyDefaultLimit?: boolean

                                            apply default relay limits to a new reservation

                                            Default

                                            true
                                            -

                                            Optional defaultDataLimit

                                            defaultDataLimit?: bigint

                                            The maximum amount of data allowed to be transferred over a relayed connection

                                            -

                                            Optional defaultDurationLimit

                                            defaultDurationLimit?: number

                                            The maximum time a relayed connection can be open for

                                            -

                                            Optional maxReservations

                                            maxReservations?: number

                                            maximum number of reservations allowed

                                            +

                                            Optional defaultDataLimit

                                            defaultDataLimit?: bigint

                                            The maximum amount of data allowed to be transferred over a relayed connection

                                            +

                                            Optional defaultDurationLimit

                                            defaultDurationLimit?: number

                                            The maximum time a relayed connection can be open for

                                            +

                                            Optional maxReservations

                                            maxReservations?: number

                                            maximum number of reservations allowed

                                            Default

                                            15
                                            -

                                            Optional reservationClearInterval

                                            reservationClearInterval?: number

                                            interval after which stale reservations are cleared

                                            +

                                            Optional reservationClearInterval

                                            reservationClearInterval?: number

                                            interval after which stale reservations are cleared

                                            Default

                                            300000
                                            -

                                            Optional reservationTtl

                                            reservationTtl?: number

                                            reservation ttl

                                            +

                                            Optional reservationTtl

                                            reservationTtl?: number

                                            reservation ttl

                                            Default

                                            7200000
                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            applyDefaultLimitdefaultDataLimitdefaultDurationLimitmaxReservationsreservationClearIntervalreservationTtl
                                            \ No newline at end of file +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            applyDefaultLimitdefaultDataLimitdefaultDurationLimitmaxReservationsreservationClearIntervalreservationTtl
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_circuit_relay_v2.TransportReservationStoreInit.html b/interfaces/_libp2p_circuit_relay_v2.TransportReservationStoreInit.html index f125a02be0..62d0ef3635 100644 --- a/interfaces/_libp2p_circuit_relay_v2.TransportReservationStoreInit.html +++ b/interfaces/_libp2p_circuit_relay_v2.TransportReservationStoreInit.html @@ -1,13 +1,13 @@ -TransportReservationStoreInit | libp2p

                                            Interface TransportReservationStoreInit

                                            interface TransportReservationStoreInit {
                                                maxReservationQueueLength?: number;
                                                reservationCompletionTimeout?: number;
                                                reservationConcurrency?: number;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            maxReservationQueueLength? +TransportReservationStoreInit | libp2p

                                            Interface TransportReservationStoreInit

                                            interface TransportReservationStoreInit {
                                                maxReservationQueueLength?: number;
                                                reservationCompletionTimeout?: number;
                                                reservationConcurrency?: number;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            maxReservationQueueLength? reservationCompletionTimeout? reservationConcurrency?

                                            Properties

                                            Optional maxReservationQueueLength

                                            maxReservationQueueLength?: number

                                            Limit the number of potential relays we will dial

                                            Default

                                            100
                                            -

                                            Optional reservationCompletionTimeout

                                            reservationCompletionTimeout?: number

                                            When creating a reservation it must complete within this number of ms

                                            +

                                            Optional reservationCompletionTimeout

                                            reservationCompletionTimeout?: number

                                            When creating a reservation it must complete within this number of ms

                                            Default

                                            5000
                                            -

                                            Optional reservationConcurrency

                                            reservationConcurrency?: number

                                            Multiple relays may be discovered simultaneously - to prevent listening +

                                            Optional reservationConcurrency

                                            reservationConcurrency?: number

                                            Multiple relays may be discovered simultaneously - to prevent listening on too many relays, this value controls how many to attempt to reserve a slot on at once. If set to more than one, we may end up listening on more relays than the maxReservations value, but on networks with poor @@ -15,4 +15,4 @@ simultaneously.

                                            Default

                                            1
                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            maxReservationQueueLengthreservationCompletionTimeoutreservationConcurrency
                                            \ No newline at end of file +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            maxReservationQueueLengthreservationCompletionTimeoutreservationConcurrency
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_config.LoadOrCreateSelfKeyOptions.html b/interfaces/_libp2p_config.LoadOrCreateSelfKeyOptions.html index 9b545cddac..d017cbce7f 100644 --- a/interfaces/_libp2p_config.LoadOrCreateSelfKeyOptions.html +++ b/interfaces/_libp2p_config.LoadOrCreateSelfKeyOptions.html @@ -1,7 +1,7 @@ -LoadOrCreateSelfKeyOptions | libp2p

                                            Interface LoadOrCreateSelfKeyOptions

                                            interface LoadOrCreateSelfKeyOptions {
                                                dek?: DEKConfig;
                                                keyType?: KeyType;
                                                pass?: string;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            dek? +LoadOrCreateSelfKeyOptions | libp2p

                                            Interface LoadOrCreateSelfKeyOptions

                                            interface LoadOrCreateSelfKeyOptions {
                                                dek?: DEKConfig;
                                                keyType?: KeyType;
                                                pass?: string;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            dek? keyType? pass?

                                            Properties

                                            Optional dek

                                            dek?: DEKConfig

                                            Optional keyType

                                            keyType?: KeyType

                                            If no private key is found in the datastore, create one with this type

                                            Default

                                            'Ed25519'
                                            -

                                            Optional pass

                                            pass?: string

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            dekkeyTypepass
                                            \ No newline at end of file +

                                            Optional pass

                                            pass?: string

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            dekkeyTypepass
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_crypto.hmac.HMAC.html b/interfaces/_libp2p_crypto.hmac.HMAC.html index 49af6388f2..8c7492fc01 100644 --- a/interfaces/_libp2p_crypto.hmac.HMAC.html +++ b/interfaces/_libp2p_crypto.hmac.HMAC.html @@ -1,3 +1,3 @@ -HMAC | libp2p

                                            Interface HMAC

                                            interface HMAC {
                                                length: number;
                                                digest(data): Promise<Uint8Array>;
                                            }

                                            Properties

                                            length +HMAC | libp2p

                                            Interface HMAC

                                            interface HMAC {
                                                length: number;
                                                digest(data): Promise<Uint8Array>;
                                            }

                                            Properties

                                            length

                                            Methods

                                            digest -

                                            Properties

                                            length

                                            length: number

                                            Methods

                                            digest

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            lengthdigest
                                            \ No newline at end of file +

                                            Properties

                                            length

                                            length: number

                                            Methods

                                            digest

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            lengthdigest
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_crypto.keys.ECDHKey.html b/interfaces/_libp2p_crypto.keys.ECDHKey.html index 25a76d92cb..c27c09cfbe 100644 --- a/interfaces/_libp2p_crypto.keys.ECDHKey.html +++ b/interfaces/_libp2p_crypto.keys.ECDHKey.html @@ -1,3 +1,3 @@ -ECDHKey | libp2p

                                            Interface ECDHKey

                                            interface ECDHKey {
                                                key: Uint8Array;
                                                genSharedKey(theirPub, forcePrivate?): Promise<Uint8Array>;
                                            }

                                            Properties

                                            key +ECDHKey | libp2p

                                            Interface ECDHKey

                                            interface ECDHKey {
                                                key: Uint8Array;
                                                genSharedKey(theirPub, forcePrivate?): Promise<Uint8Array>;
                                            }

                                            Properties

                                            key

                                            Methods

                                            genSharedKey -

                                            Properties

                                            key

                                            key: Uint8Array

                                            Methods

                                            genSharedKey

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            keygenSharedKey
                                            \ No newline at end of file +

                                            Properties

                                            key

                                            key: Uint8Array

                                            Methods

                                            genSharedKey

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            keygenSharedKey
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_crypto.keys.ECDHKeyPair.html b/interfaces/_libp2p_crypto.keys.ECDHKeyPair.html index b30a1ed82e..dd1ceeffcd 100644 --- a/interfaces/_libp2p_crypto.keys.ECDHKeyPair.html +++ b/interfaces/_libp2p_crypto.keys.ECDHKeyPair.html @@ -1,3 +1,3 @@ -ECDHKeyPair | libp2p

                                            Interface ECDHKeyPair

                                            interface ECDHKeyPair {
                                                private: Uint8Array;
                                                public: Uint8Array;
                                            }

                                            Properties

                                            private +ECDHKeyPair | libp2p

                                            Interface ECDHKeyPair

                                            interface ECDHKeyPair {
                                                private: Uint8Array;
                                                public: Uint8Array;
                                            }

                                            Properties

                                            private public -

                                            Properties

                                            private

                                            private: Uint8Array

                                            public

                                            public: Uint8Array

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            privatepublic
                                            \ No newline at end of file +

                                            Properties

                                            private

                                            private: Uint8Array

                                            public

                                            public: Uint8Array

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            privatepublic
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_crypto.keys.EnhancedKey.html b/interfaces/_libp2p_crypto.keys.EnhancedKey.html index 38bd6d7b13..61ae2a263b 100644 --- a/interfaces/_libp2p_crypto.keys.EnhancedKey.html +++ b/interfaces/_libp2p_crypto.keys.EnhancedKey.html @@ -1,4 +1,4 @@ -EnhancedKey | libp2p

                                            Interface EnhancedKey

                                            interface EnhancedKey {
                                                cipherKey: Uint8Array;
                                                iv: Uint8Array;
                                                macKey: Uint8Array;
                                            }

                                            Properties

                                            cipherKey +EnhancedKey | libp2p

                                            Interface EnhancedKey

                                            interface EnhancedKey {
                                                cipherKey: Uint8Array;
                                                iv: Uint8Array;
                                                macKey: Uint8Array;
                                            }

                                            Properties

                                            cipherKey iv macKey -

                                            Properties

                                            cipherKey

                                            cipherKey: Uint8Array

                                            iv

                                            iv: Uint8Array

                                            macKey

                                            macKey: Uint8Array

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            cipherKeyivmacKey
                                            \ No newline at end of file +

                                            Properties

                                            cipherKey

                                            cipherKey: Uint8Array

                                            iv

                                            iv: Uint8Array

                                            macKey

                                            macKey: Uint8Array

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            cipherKeyivmacKey
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_crypto.keys.EnhancedKeyPair.html b/interfaces/_libp2p_crypto.keys.EnhancedKeyPair.html index c9fe53e672..84df1814cc 100644 --- a/interfaces/_libp2p_crypto.keys.EnhancedKeyPair.html +++ b/interfaces/_libp2p_crypto.keys.EnhancedKeyPair.html @@ -1,3 +1,3 @@ -EnhancedKeyPair | libp2p

                                            Interface EnhancedKeyPair

                                            interface EnhancedKeyPair {
                                                k1: EnhancedKey;
                                                k2: EnhancedKey;
                                            }

                                            Properties

                                            k1 +EnhancedKeyPair | libp2p

                                            Interface EnhancedKeyPair

                                            interface EnhancedKeyPair {
                                                k1: EnhancedKey;
                                                k2: EnhancedKey;
                                            }

                                            Properties

                                            k1 k2 -

                                            Properties

                                            k1

                                            k1: EnhancedKey

                                            k2

                                            k2: EnhancedKey

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            k1k2
                                            \ No newline at end of file +

                                            Properties

                                            k1

                                            k1: EnhancedKey

                                            k2

                                            k2: EnhancedKey

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            k1k2
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_dcutr.DCUtRServiceComponents.html b/interfaces/_libp2p_dcutr.DCUtRServiceComponents.html index c30b2581f1..6ed01a11a6 100644 --- a/interfaces/_libp2p_dcutr.DCUtRServiceComponents.html +++ b/interfaces/_libp2p_dcutr.DCUtRServiceComponents.html @@ -1,7 +1,7 @@ -DCUtRServiceComponents | libp2p

                                            Interface DCUtRServiceComponents

                                            interface DCUtRServiceComponents {
                                                addressManager: AddressManager;
                                                connectionManager: ConnectionManager;
                                                logger: ComponentLogger;
                                                peerStore: PeerStore;
                                                registrar: Registrar;
                                                transportManager: TransportManager;
                                            }

                                            Properties

                                            addressManager +DCUtRServiceComponents | libp2p

                                            Interface DCUtRServiceComponents

                                            interface DCUtRServiceComponents {
                                                addressManager: AddressManager;
                                                connectionManager: ConnectionManager;
                                                logger: ComponentLogger;
                                                peerStore: PeerStore;
                                                registrar: Registrar;
                                                transportManager: TransportManager;
                                            }

                                            Properties

                                            addressManager connectionManager logger peerStore registrar transportManager -

                                            Properties

                                            addressManager

                                            addressManager: AddressManager

                                            connectionManager

                                            connectionManager: ConnectionManager

                                            logger

                                            logger: ComponentLogger

                                            peerStore

                                            peerStore: PeerStore

                                            registrar

                                            registrar: Registrar

                                            transportManager

                                            transportManager: TransportManager

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            addressManagerconnectionManagerloggerpeerStoreregistrartransportManager
                                            \ No newline at end of file +

                                            Properties

                                            addressManager

                                            addressManager: AddressManager

                                            connectionManager

                                            connectionManager: ConnectionManager

                                            logger

                                            logger: ComponentLogger

                                            peerStore

                                            peerStore: PeerStore

                                            registrar

                                            registrar: Registrar

                                            transportManager

                                            transportManager: TransportManager

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            addressManagerconnectionManagerloggerpeerStoreregistrartransportManager
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_dcutr.DCUtRServiceInit.html b/interfaces/_libp2p_dcutr.DCUtRServiceInit.html index 97ce098d21..6a980a1d1a 100644 --- a/interfaces/_libp2p_dcutr.DCUtRServiceInit.html +++ b/interfaces/_libp2p_dcutr.DCUtRServiceInit.html @@ -1,4 +1,4 @@ -DCUtRServiceInit | libp2p

                                            Interface DCUtRServiceInit

                                            interface DCUtRServiceInit {
                                                maxInboundStreams?: number;
                                                maxOutboundStreams?: number;
                                                retries?: number;
                                                timeout?: number;
                                            }

                                            Properties

                                            maxInboundStreams? +DCUtRServiceInit | libp2p

                                            Interface DCUtRServiceInit

                                            interface DCUtRServiceInit {
                                                maxInboundStreams?: number;
                                                maxOutboundStreams?: number;
                                                retries?: number;
                                                timeout?: number;
                                            }

                                            Properties

                                            maxInboundStreams? maxOutboundStreams? retries? timeout? @@ -6,14 +6,14 @@ connection

                                            Default

                                            1
                                            -

                                            Optional maxOutboundStreams

                                            maxOutboundStreams?: number

                                            How many simultaneous outbound DCUtR protocol streams to allow on each +

                                            Optional maxOutboundStreams

                                            maxOutboundStreams?: number

                                            How many simultaneous outbound DCUtR protocol streams to allow on each connection

                                            Default

                                            1
                                            -

                                            Optional retries

                                            retries?: number

                                            How many times to retry the connection upgrade

                                            +

                                            Optional retries

                                            retries?: number

                                            How many times to retry the connection upgrade

                                            Default

                                            3
                                            -

                                            Optional timeout

                                            timeout?: number

                                            How long we should wait for the connection upgrade to complete

                                            +

                                            Optional timeout

                                            timeout?: number

                                            How long we should wait for the connection upgrade to complete

                                            Default

                                            5000
                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            maxInboundStreamsmaxOutboundStreamsretriestimeout
                                            \ No newline at end of file +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            maxInboundStreamsmaxOutboundStreamsretriestimeout
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.index.Address.html b/interfaces/_libp2p_devtools_metrics.index.Address.html index aee58947c1..c6c7c84f69 100644 --- a/interfaces/_libp2p_devtools_metrics.index.Address.html +++ b/interfaces/_libp2p_devtools_metrics.index.Address.html @@ -1,8 +1,8 @@ -Address | libp2p

                                            Interface Address

                                            interface Address {
                                                isCertified?: boolean;
                                                isConnected?: boolean;
                                                multiaddr: string;
                                            }

                                            Properties

                                            isCertified? +Address | libp2p

                                            Interface Address

                                            interface Address {
                                                isCertified?: boolean;
                                                isConnected?: boolean;
                                                multiaddr: string;
                                            }

                                            Properties

                                            isCertified? isConnected? multiaddr

                                            Properties

                                            Optional isCertified

                                            isCertified?: boolean

                                            If true, this multiaddr came from a signed peer record

                                            -

                                            Optional isConnected

                                            isConnected?: boolean

                                            If true, the current node has an active connection to this peer via this +

                                            Optional isConnected

                                            isConnected?: boolean

                                            If true, the current node has an active connection to this peer via this address

                                            -

                                            multiaddr

                                            multiaddr: string

                                            The multiaddr this address represents

                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            isCertifiedisConnectedmultiaddr
                                            \ No newline at end of file +

                                            multiaddr

                                            multiaddr: string

                                            The multiaddr this address represents

                                            +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            isCertifiedisConnectedmultiaddr
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.index.CopyToClipboardMessage.html b/interfaces/_libp2p_devtools_metrics.index.CopyToClipboardMessage.html index e67a14954d..9fdba5fe51 100644 --- a/interfaces/_libp2p_devtools_metrics.index.CopyToClipboardMessage.html +++ b/interfaces/_libp2p_devtools_metrics.index.CopyToClipboardMessage.html @@ -1,7 +1,7 @@ CopyToClipboardMessage | libp2p

                                            Interface CopyToClipboardMessage

                                            This event is intercepted by the service worker which injects a content script into the current page which copies the passed value to the clipboard.

                                            -
                                            interface CopyToClipboardMessage {
                                                source: "@libp2p/devtools-metrics:devtools";
                                                tabId: number;
                                                type: "copy-to-clipboard";
                                                value: string;
                                            }

                                            Properties

                                            source +
                                            interface CopyToClipboardMessage {
                                                source: "@libp2p/devtools-metrics:devtools";
                                                tabId: number;
                                                type: "copy-to-clipboard";
                                                value: string;
                                            }

                                            Properties

                                            source tabId type value -

                                            Properties

                                            source

                                            source: "@libp2p/devtools-metrics:devtools"

                                            tabId

                                            tabId: number

                                            type

                                            type: "copy-to-clipboard"

                                            value

                                            value: string

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            sourcetabIdtypevalue
                                            \ No newline at end of file +

                                            Properties

                                            source

                                            source: "@libp2p/devtools-metrics:devtools"

                                            tabId

                                            tabId: number

                                            type

                                            type: "copy-to-clipboard"

                                            value

                                            value: string

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            sourcetabIdtypevalue
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.index.DevToolsMetricsComponents.html b/interfaces/_libp2p_devtools_metrics.index.DevToolsMetricsComponents.html index df8e2a4c3a..1d11da40c6 100644 --- a/interfaces/_libp2p_devtools_metrics.index.DevToolsMetricsComponents.html +++ b/interfaces/_libp2p_devtools_metrics.index.DevToolsMetricsComponents.html @@ -1,4 +1,4 @@ -DevToolsMetricsComponents | libp2p

                                            Interface DevToolsMetricsComponents

                                            interface DevToolsMetricsComponents {
                                                addressManager: AddressManager;
                                                connectionManager: ConnectionManager;
                                                contentRouting: ContentRouting;
                                                events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                logger: ComponentLogger;
                                                peerId: PeerId;
                                                peerRouting: PeerRouting;
                                                peerStore: PeerStore;
                                                registrar: Registrar;
                                                transportManager: TransportManager;
                                            }

                                            Properties

                                            addressManager +DevToolsMetricsComponents | libp2p

                                            Interface DevToolsMetricsComponents

                                            interface DevToolsMetricsComponents {
                                                addressManager: AddressManager;
                                                connectionManager: ConnectionManager;
                                                contentRouting: ContentRouting;
                                                events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                logger: ComponentLogger;
                                                peerId: PeerId;
                                                peerRouting: PeerRouting;
                                                peerStore: PeerStore;
                                                registrar: Registrar;
                                                transportManager: TransportManager;
                                            }

                                            Properties

                                            addressManager connectionManager contentRouting events @@ -8,4 +8,4 @@ peerStore registrar transportManager -

                                            Properties

                                            addressManager

                                            addressManager: AddressManager

                                            connectionManager

                                            connectionManager: ConnectionManager

                                            contentRouting

                                            contentRouting: ContentRouting

                                            events

                                            events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                            logger

                                            logger: ComponentLogger

                                            peerId

                                            peerId: PeerId

                                            peerRouting

                                            peerRouting: PeerRouting

                                            peerStore

                                            peerStore: PeerStore

                                            registrar

                                            registrar: Registrar

                                            transportManager

                                            transportManager: TransportManager

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            addressManagerconnectionManagercontentRoutingeventsloggerpeerIdpeerRoutingpeerStoreregistrartransportManager
                                            \ No newline at end of file +

                                            Properties

                                            addressManager

                                            addressManager: AddressManager

                                            connectionManager

                                            connectionManager: ConnectionManager

                                            contentRouting

                                            contentRouting: ContentRouting

                                            events

                                            events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                            logger

                                            logger: ComponentLogger

                                            peerId

                                            peerId: PeerId

                                            peerRouting

                                            peerRouting: PeerRouting

                                            peerStore

                                            peerStore: PeerStore

                                            registrar

                                            registrar: Registrar

                                            transportManager

                                            transportManager: TransportManager

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            addressManagerconnectionManagercontentRoutingeventsloggerpeerIdpeerRoutingpeerStoreregistrartransportManager
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.index.DevToolsMetricsInit.html b/interfaces/_libp2p_devtools_metrics.index.DevToolsMetricsInit.html index 18e6671eaf..bbd4847070 100644 --- a/interfaces/_libp2p_devtools_metrics.index.DevToolsMetricsInit.html +++ b/interfaces/_libp2p_devtools_metrics.index.DevToolsMetricsInit.html @@ -1,3 +1,3 @@ -DevToolsMetricsInit | libp2p

                                            Interface DevToolsMetricsInit

                                            interface DevToolsMetricsInit {
                                                intervalMs?: number;
                                            }

                                            Properties

                                            intervalMs? +DevToolsMetricsInit | libp2p

                                            Interface DevToolsMetricsInit

                                            interface DevToolsMetricsInit {
                                                intervalMs?: number;
                                            }

                                            Properties

                                            intervalMs?

                                            Properties

                                            Optional intervalMs

                                            intervalMs?: number

                                            How often to pass metrics to the DevTools panel

                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            intervalMs
                                            \ No newline at end of file +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            intervalMs
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.index.PageLoadedMessage.html b/interfaces/_libp2p_devtools_metrics.index.PageLoadedMessage.html index 7966d79fc2..1f755e4a15 100644 --- a/interfaces/_libp2p_devtools_metrics.index.PageLoadedMessage.html +++ b/interfaces/_libp2p_devtools_metrics.index.PageLoadedMessage.html @@ -1,6 +1,6 @@ PageLoadedMessage | libp2p

                                            Interface PageLoadedMessage

                                            Sent by the DevTools service worker to the DevTools panel when the inspected page has finished (re)loading

                                            -
                                            interface PageLoadedMessage {
                                                source: "@libp2p/devtools-metrics:devtools";
                                                tabId: number;
                                                type: "page-loaded";
                                            }

                                            Properties

                                            source +
                                            interface PageLoadedMessage {
                                                source: "@libp2p/devtools-metrics:devtools";
                                                tabId: number;
                                                type: "page-loaded";
                                            }

                                            Properties

                                            source tabId type -

                                            Properties

                                            source

                                            source: "@libp2p/devtools-metrics:devtools"

                                            tabId

                                            tabId: number

                                            type

                                            type: "page-loaded"

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            sourcetabIdtype
                                            \ No newline at end of file +

                                            Properties

                                            source

                                            source: "@libp2p/devtools-metrics:devtools"

                                            tabId

                                            tabId: number

                                            type

                                            type: "page-loaded"

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            sourcetabIdtype
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.index.PermissionsErrorMessage.html b/interfaces/_libp2p_devtools_metrics.index.PermissionsErrorMessage.html index 2d91d07bd9..6b5f351bf2 100644 --- a/interfaces/_libp2p_devtools_metrics.index.PermissionsErrorMessage.html +++ b/interfaces/_libp2p_devtools_metrics.index.PermissionsErrorMessage.html @@ -2,7 +2,7 @@ to send a message to the inspected page as there is no receiving end present.

                                            This normally means the content script has not been loaded due to the user not having granted permission for the script to run.

                                            -
                                            interface PermissionsErrorMessage {
                                                source: "@libp2p/devtools-metrics:devtools";
                                                tabId: number;
                                                type: "permissions-error";
                                            }

                                            Properties

                                            source +
                                            interface PermissionsErrorMessage {
                                                source: "@libp2p/devtools-metrics:devtools";
                                                tabId: number;
                                                type: "permissions-error";
                                            }

                                            Properties

                                            source tabId type -

                                            Properties

                                            source

                                            source: "@libp2p/devtools-metrics:devtools"

                                            tabId

                                            tabId: number

                                            type

                                            type: "permissions-error"

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            sourcetabIdtype
                                            \ No newline at end of file +

                                            Properties

                                            source

                                            source: "@libp2p/devtools-metrics:devtools"

                                            tabId

                                            tabId: number

                                            type

                                            type: "permissions-error"

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            sourcetabIdtype
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.index.RPCMessage.html b/interfaces/_libp2p_devtools_metrics.index.RPCMessage.html index 70914735f9..04923af250 100644 --- a/interfaces/_libp2p_devtools_metrics.index.RPCMessage.html +++ b/interfaces/_libp2p_devtools_metrics.index.RPCMessage.html @@ -1,7 +1,7 @@ RPCMessage | libp2p

                                            Interface RPCMessage

                                            Invoke a method on the libp2p object

                                            -
                                            interface RPCMessage {
                                                message: string;
                                                source: "@libp2p/devtools-metrics:devtools" | "@libp2p/devtools-metrics:metrics";
                                                tabId: number;
                                                type: "libp2p-rpc";
                                            }

                                            Properties

                                            message +
                                            interface RPCMessage {
                                                message: string;
                                                source: "@libp2p/devtools-metrics:devtools" | "@libp2p/devtools-metrics:metrics";
                                                tabId: number;
                                                type: "libp2p-rpc";
                                            }

                                            Properties

                                            message source tabId type

                                            Properties

                                            message

                                            message: string

                                            The RPC message encoded as a multibase string

                                            -

                                            source

                                            source: "@libp2p/devtools-metrics:devtools" | "@libp2p/devtools-metrics:metrics"

                                            tabId

                                            tabId: number

                                            type

                                            type: "libp2p-rpc"

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            messagesourcetabIdtype
                                            \ No newline at end of file +

                                            source

                                            source: "@libp2p/devtools-metrics:devtools" | "@libp2p/devtools-metrics:metrics"

                                            tabId

                                            tabId: number

                                            type

                                            type: "libp2p-rpc"

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            messagesourcetabIdtype
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.rpc.DevToolsEvents.html b/interfaces/_libp2p_devtools_metrics.rpc.DevToolsEvents.html index 3a1220ad71..854b3105a0 100644 --- a/interfaces/_libp2p_devtools_metrics.rpc.DevToolsEvents.html +++ b/interfaces/_libp2p_devtools_metrics.rpc.DevToolsEvents.html @@ -1,11 +1,11 @@ -DevToolsEvents | libp2p

                                            Interface DevToolsEvents

                                            interface DevToolsEvents {
                                                metrics: CustomEvent<Record<string, any>>;
                                                peers: CustomEvent<Peer[]>;
                                                pubsub:message: CustomEvent<PubSubRPCMessage>;
                                                pubsub:subscription-change: CustomEvent<SubscriptionChangeData>;
                                                self: CustomEvent<Peer>;
                                            }

                                            Properties

                                            metrics +DevToolsEvents | libp2p

                                            Interface DevToolsEvents

                                            interface DevToolsEvents {
                                                metrics: CustomEvent<Record<string, any>>;
                                                peers: CustomEvent<Peer[]>;
                                                pubsub:message: CustomEvent<PubSubRPCMessage>;
                                                pubsub:subscription-change: CustomEvent<SubscriptionChangeData>;
                                                self: CustomEvent<Peer>;
                                            }

                                            Properties

                                            metrics peers pubsub:message pubsub:subscription-change self

                                            Properties

                                            metrics

                                            metrics: CustomEvent<Record<string, any>>

                                            Node metrics have been updated

                                            -

                                            peers

                                            peers: CustomEvent<Peer[]>

                                            The node's connected peers have changed

                                            -

                                            pubsub:message

                                            pubsub:message: CustomEvent<PubSubRPCMessage>

                                            A pubsub message was received

                                            -

                                            pubsub:subscription-change

                                            pubsub:subscription-change: CustomEvent<SubscriptionChangeData>

                                            The subscriptions of a peer have changed

                                            -

                                            self

                                            self: CustomEvent<Peer>

                                            The node's status has changed - new addresses and/or protocols, etc

                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            metricspeerspubsub:messagepubsub:subscription-changeself
                                            \ No newline at end of file +

                                            peers

                                            peers: CustomEvent<Peer[]>

                                            The node's connected peers have changed

                                            +

                                            pubsub:message

                                            pubsub:message: CustomEvent<PubSubRPCMessage>

                                            A pubsub message was received

                                            +

                                            pubsub:subscription-change

                                            pubsub:subscription-change: CustomEvent<SubscriptionChangeData>

                                            The subscriptions of a peer have changed

                                            +

                                            self

                                            self: CustomEvent<Peer>

                                            The node's status has changed - new addresses and/or protocols, etc

                                            +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            metricspeerspubsub:messagepubsub:subscription-changeself
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.rpc.DevToolsRPC.html b/interfaces/_libp2p_devtools_metrics.rpc.DevToolsRPC.html index 632ae08f03..b45b8142c1 100644 --- a/interfaces/_libp2p_devtools_metrics.rpc.DevToolsRPC.html +++ b/interfaces/_libp2p_devtools_metrics.rpc.DevToolsRPC.html @@ -1,3 +1,3 @@ DevToolsRPC | libp2p

                                            Interface DevToolsRPC

                                            RPC operations exposed by the DevTools

                                            -
                                            interface DevToolsRPC {
                                                safeDispatchEvent<Detail>(type, detail?): Promise<void>;
                                            }

                                            Methods

                                            safeDispatchEvent -

                                            Methods

                                            safeDispatchEvent

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            safeDispatchEvent
                                            \ No newline at end of file +
                                            interface DevToolsRPC {
                                                safeDispatchEvent<Detail>(type, detail?): Promise<void>;
                                            }

                                            Methods

                                            safeDispatchEvent +

                                            Methods

                                            safeDispatchEvent

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            safeDispatchEvent
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.rpc.MetricsRPC.html b/interfaces/_libp2p_devtools_metrics.rpc.MetricsRPC.html index 2280ca7828..4a2ff04b75 100644 --- a/interfaces/_libp2p_devtools_metrics.rpc.MetricsRPC.html +++ b/interfaces/_libp2p_devtools_metrics.rpc.MetricsRPC.html @@ -1,5 +1,5 @@ MetricsRPC | libp2p

                                            Interface MetricsRPC

                                            RPC operations exposed by the metrics

                                            -
                                            interface MetricsRPC {
                                                contentRouting: ContentRouting;
                                                peerRouting: PeerRouting;
                                                pubsub: {
                                                    getSubscribers(component, topic): Promise<PeerId[]>;
                                                    getTopics(component): Promise<string[]>;
                                                    publish(component, topic, message): Promise<void>;
                                                    subscribe(component, topic): Promise<void>;
                                                    unsubscribe(component, topic): Promise<void>;
                                                };
                                                closeConnection(peerId, options?): Promise<void>;
                                                init(options?): Promise<{
                                                    capabilities: Record<string, string[]>;
                                                    debug: string;
                                                    peers: Peer[];
                                                    self: Peer;
                                                }>;
                                                openConnection(peerIdOrMultiaddr, options?): Promise<void>;
                                                setDebug(namespace?): Promise<void>;
                                            }

                                            Properties

                                            contentRouting +
                                            interface MetricsRPC {
                                                contentRouting: ContentRouting;
                                                peerRouting: PeerRouting;
                                                pubsub: {
                                                    getSubscribers(component, topic): Promise<PeerId[]>;
                                                    getTopics(component): Promise<string[]>;
                                                    publish(component, topic, message): Promise<void>;
                                                    subscribe(component, topic): Promise<void>;
                                                    unsubscribe(component, topic): Promise<void>;
                                                };
                                                closeConnection(peerId, options?): Promise<void>;
                                                init(options?): Promise<{
                                                    capabilities: Record<string, string[]>;
                                                    debug: string;
                                                    peers: Peer[];
                                                    self: Peer;
                                                }>;
                                                openConnection(peerIdOrMultiaddr, options?): Promise<void>;
                                                setDebug(namespace?): Promise<void>;
                                            }

                                            Properties

                                            contentRouting peerRouting pubsub

                                            Methods

                                            closeConnection @@ -7,15 +7,15 @@ openConnection setDebug

                                            Properties

                                            contentRouting

                                            contentRouting: ContentRouting

                                            Make content routing queries

                                            -

                                            peerRouting

                                            peerRouting: PeerRouting

                                            Make peer routing queries

                                            -

                                            pubsub

                                            pubsub: {
                                                getSubscribers(component, topic): Promise<PeerId[]>;
                                                getTopics(component): Promise<string[]>;
                                                publish(component, topic, message): Promise<void>;
                                                subscribe(component, topic): Promise<void>;
                                                unsubscribe(component, topic): Promise<void>;
                                            }

                                            PubSub operations

                                            +

                                            peerRouting

                                            peerRouting: PeerRouting

                                            Make peer routing queries

                                            +

                                            pubsub

                                            pubsub: {
                                                getSubscribers(component, topic): Promise<PeerId[]>;
                                                getTopics(component): Promise<string[]>;
                                                publish(component, topic, message): Promise<void>;
                                                subscribe(component, topic): Promise<void>;
                                                unsubscribe(component, topic): Promise<void>;
                                            }

                                            PubSub operations

                                            Type declaration

                                            • getSubscribers:function
                                            • getTopics:function
                                              • getTopics(component): Promise<string[]>

                                              • Get the list of subscriptions for the current node

                                                -

                                                Parameters

                                                • component: string

                                                Returns Promise<string[]>

                                            • publish:function
                                            • subscribe:function
                                              • subscribe(component, topic): Promise<void>

                                              • Subscribe to a PubSub topic

                                                -

                                                Parameters

                                                • component: string
                                                • topic: string

                                                Returns Promise<void>

                                            • unsubscribe:function
                                              • unsubscribe(component, topic): Promise<void>

                                              • Unsubscribe from a PubSub topic

                                                -

                                                Parameters

                                                • component: string
                                                • topic: string

                                                Returns Promise<void>

                                            Methods

                                            closeConnection

                                            init

                                            • init(options?): Promise<{
                                                  capabilities: Record<string, string[]>;
                                                  debug: string;
                                                  peers: Peer[];
                                                  self: Peer;
                                              }>

                                            • Called by DevTools on initial connect

                                              -

                                              Parameters

                                              Returns Promise<{
                                                  capabilities: Record<string, string[]>;
                                                  debug: string;
                                                  peers: Peer[];
                                                  self: Peer;
                                              }>

                                            openConnection

                                            setDebug

                                            • setDebug(namespace?): Promise<void>

                                            • Update the currently active debugging namespaces

                                              -

                                              Parameters

                                              • Optional namespace: string

                                              Returns Promise<void>

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            contentRoutingpeerRoutingpubsubcloseConnectioninitopenConnectionsetDebug
                                            \ No newline at end of file +

                                            Parameters

                                            Returns Promise<PeerId[]>

                                          • getTopics:function
                                          • publish:function
                                          • subscribe:function
                                          • unsubscribe:function

                                            • Methods

                                            closeConnection

                                            init

                                            openConnection

                                            setDebug

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            contentRoutingpeerRoutingpubsubcloseConnectioninitopenConnectionsetDebug
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.rpc.Peer.html b/interfaces/_libp2p_devtools_metrics.rpc.Peer.html index 945bdd314d..2f75f6939f 100644 --- a/interfaces/_libp2p_devtools_metrics.rpc.Peer.html +++ b/interfaces/_libp2p_devtools_metrics.rpc.Peer.html @@ -1,11 +1,11 @@ -Peer | libp2p

                                            Interface Peer

                                            interface Peer {
                                                addresses: PeerAddress[];
                                                id: PeerId;
                                                metadata: Record<string, string>;
                                                protocols: string[];
                                                tags: Record<string, number>;
                                            }

                                            Properties

                                            addresses +Peer | libp2p

                                            Interface Peer

                                            interface Peer {
                                                addresses: PeerAddress[];
                                                id: PeerId;
                                                metadata: Record<string, string>;
                                                protocols: string[];
                                                tags: Record<string, number>;
                                            }

                                            Properties

                                            addresses id metadata protocols tags

                                            Properties

                                            addresses

                                            addresses: PeerAddress[]

                                            The list of addresses the peer has that we know about

                                            -

                                            id

                                            id: PeerId

                                            The identifier of the remote peer

                                            -

                                            metadata

                                            metadata: Record<string, string>

                                            Any peer store metadata the peer has

                                            -

                                            protocols

                                            protocols: string[]

                                            The protocols the peer supports, if known

                                            -

                                            tags

                                            tags: Record<string, number>

                                            Any peer store tags the peer has

                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            addressesidmetadataprotocolstags
                                            \ No newline at end of file +

                                            id

                                            id: PeerId

                                            The identifier of the remote peer

                                            +

                                            metadata

                                            metadata: Record<string, string>

                                            Any peer store metadata the peer has

                                            +

                                            protocols

                                            protocols: string[]

                                            The protocols the peer supports, if known

                                            +

                                            tags

                                            tags: Record<string, number>

                                            Any peer store tags the peer has

                                            +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            addressesidmetadataprotocolstags
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.rpc.PeerAddress.html b/interfaces/_libp2p_devtools_metrics.rpc.PeerAddress.html index 0bcba7b90b..489adcf8e1 100644 --- a/interfaces/_libp2p_devtools_metrics.rpc.PeerAddress.html +++ b/interfaces/_libp2p_devtools_metrics.rpc.PeerAddress.html @@ -1,4 +1,4 @@ -PeerAddress | libp2p

                                            Interface PeerAddress

                                            interface PeerAddress {
                                                isCertified?: boolean;
                                                isConnected?: boolean;
                                                multiaddr: Multiaddr;
                                            }

                                            Properties

                                            isCertified? +PeerAddress | libp2p

                                            Interface PeerAddress

                                            interface PeerAddress {
                                                isCertified?: boolean;
                                                isConnected?: boolean;
                                                multiaddr: Multiaddr;
                                            }

                                            Properties

                                            isCertified? isConnected? multiaddr -

                                            Properties

                                            Optional isCertified

                                            isCertified?: boolean

                                            Optional isConnected

                                            isConnected?: boolean

                                            multiaddr

                                            multiaddr: Multiaddr

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            isCertifiedisConnectedmultiaddr
                                            \ No newline at end of file +

                                            Properties

                                            Optional isCertified

                                            isCertified?: boolean

                                            Optional isConnected

                                            isConnected?: boolean

                                            multiaddr

                                            multiaddr: Multiaddr

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            isCertifiedisConnectedmultiaddr
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_echo.Echo.html b/interfaces/_libp2p_echo.Echo.html index afb795212f..9c2285d246 100644 --- a/interfaces/_libp2p_echo.Echo.html +++ b/interfaces/_libp2p_echo.Echo.html @@ -1,3 +1,3 @@ -Echo | libp2p

                                            Interface Echo

                                            interface Echo {
                                                protocol: string;
                                                echo(peer, buf, options?): Promise<Uint8Array>;
                                            }

                                            Properties

                                            protocol +Echo | libp2p

                                            Interface Echo

                                            interface Echo {
                                                protocol: string;
                                                echo(peer, buf, options?): Promise<Uint8Array>;
                                            }

                                            Properties

                                            protocol

                                            Methods

                                            echo -

                                            Properties

                                            protocol

                                            protocol: string

                                            Methods

                                            echo

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            protocolecho
                                            \ No newline at end of file +

                                            Properties

                                            protocol

                                            protocol: string

                                            Methods

                                            echo

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            protocolecho
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_echo.EchoComponents.html b/interfaces/_libp2p_echo.EchoComponents.html index 413812dd26..d2eca708cf 100644 --- a/interfaces/_libp2p_echo.EchoComponents.html +++ b/interfaces/_libp2p_echo.EchoComponents.html @@ -1,4 +1,4 @@ -EchoComponents | libp2p

                                            Interface EchoComponents

                                            interface EchoComponents {
                                                connectionManager: ConnectionManager;
                                                logger: ComponentLogger;
                                                registrar: Registrar;
                                            }

                                            Properties

                                            connectionManager +EchoComponents | libp2p

                                            Interface EchoComponents

                                            interface EchoComponents {
                                                connectionManager: ConnectionManager;
                                                logger: ComponentLogger;
                                                registrar: Registrar;
                                            }

                                            Properties

                                            connectionManager logger registrar -

                                            Properties

                                            connectionManager

                                            connectionManager: ConnectionManager

                                            logger

                                            logger: ComponentLogger

                                            registrar

                                            registrar: Registrar

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            connectionManagerloggerregistrar
                                            \ No newline at end of file +

                                            Properties

                                            connectionManager

                                            connectionManager: ConnectionManager

                                            logger

                                            logger: ComponentLogger

                                            registrar

                                            registrar: Registrar

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            connectionManagerloggerregistrar
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_echo.EchoInit.html b/interfaces/_libp2p_echo.EchoInit.html index ec25b5a4d0..bf160263ce 100644 --- a/interfaces/_libp2p_echo.EchoInit.html +++ b/interfaces/_libp2p_echo.EchoInit.html @@ -1,5 +1,5 @@ -EchoInit | libp2p

                                            Interface EchoInit

                                            interface EchoInit {
                                                maxInboundStreams?: number;
                                                maxOutboundStreams?: number;
                                                protocolPrefix?: string;
                                                runOnLimitedConnection?: boolean;
                                            }

                                            Properties

                                            maxInboundStreams? +EchoInit | libp2p

                                            Interface EchoInit

                                            interface EchoInit {
                                                maxInboundStreams?: number;
                                                maxOutboundStreams?: number;
                                                protocolPrefix?: string;
                                                runOnLimitedConnection?: boolean;
                                            }

                                            Properties

                                            maxInboundStreams? maxOutboundStreams? protocolPrefix? runOnLimitedConnection? -

                                            Properties

                                            Optional maxInboundStreams

                                            maxInboundStreams?: number

                                            Optional maxOutboundStreams

                                            maxOutboundStreams?: number

                                            Optional protocolPrefix

                                            protocolPrefix?: string

                                            Optional runOnLimitedConnection

                                            runOnLimitedConnection?: boolean

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            maxInboundStreamsmaxOutboundStreamsprotocolPrefixrunOnLimitedConnection
                                            \ No newline at end of file +

                                            Properties

                                            Optional maxInboundStreams

                                            maxInboundStreams?: number

                                            Optional maxOutboundStreams

                                            maxOutboundStreams?: number

                                            Optional protocolPrefix

                                            protocolPrefix?: string

                                            Optional runOnLimitedConnection

                                            runOnLimitedConnection?: boolean

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            maxInboundStreamsmaxOutboundStreamsprotocolPrefixrunOnLimitedConnection
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_fetch.Fetch.html b/interfaces/_libp2p_fetch.Fetch.html index 21141113e7..215a99ad7e 100644 --- a/interfaces/_libp2p_fetch.Fetch.html +++ b/interfaces/_libp2p_fetch.Fetch.html @@ -1,13 +1,13 @@ -Fetch | libp2p

                                            Interface Fetch

                                            interface Fetch {
                                                fetch(peer, key, options?): Promise<undefined | Uint8Array>;
                                                registerLookupFunction(prefix, lookup): void;
                                                unregisterLookupFunction(prefix, lookup?): void;
                                            }

                                            Methods

                                            fetch +Fetch | libp2p

                                            Interface Fetch

                                            interface Fetch {
                                                fetch(peer, key, options?): Promise<undefined | Uint8Array>;
                                                registerLookupFunction(prefix, lookup): void;
                                                unregisterLookupFunction(prefix, lookup?): void;
                                            }

                                            Methods

                                            fetch registerLookupFunction unregisterLookupFunction

                                            Methods

                                            fetch

                                            registerLookupFunction

                                            registerLookupFunction

                                            • registerLookupFunction(prefix, lookup): void

                                            • Registers a new lookup callback that can map keys to values, for a given set of keys that share the same prefix

                                              Parameters

                                              Returns void

                                              Example

                                              // ...
                                              libp2p.services.fetch.registerLookupFunction('/prefix', (key) => { ... })
                                              -

                                            unregisterLookupFunction

                                            • unregisterLookupFunction(prefix, lookup?): void

                                            • Registers a new lookup callback that can map keys to values, for a given set of keys that +

                                            unregisterLookupFunction

                                            • unregisterLookupFunction(prefix, lookup?): void

                                            • Registers a new lookup callback that can map keys to values, for a given set of keys that share the same prefix.

                                              Parameters

                                              Returns void

                                              Example

                                              // ...
                                              libp2p.services.fetch.unregisterLookupFunction('/prefix')
                                              -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            fetchregisterLookupFunctionunregisterLookupFunction
                                            \ No newline at end of file +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            fetchregisterLookupFunctionunregisterLookupFunction
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_fetch.FetchComponents.html b/interfaces/_libp2p_fetch.FetchComponents.html index 6d8f9fc24a..8c80a332f1 100644 --- a/interfaces/_libp2p_fetch.FetchComponents.html +++ b/interfaces/_libp2p_fetch.FetchComponents.html @@ -1,4 +1,4 @@ -FetchComponents | libp2p

                                            Interface FetchComponents

                                            interface FetchComponents {
                                                connectionManager: ConnectionManager;
                                                logger: ComponentLogger;
                                                registrar: Registrar;
                                            }

                                            Properties

                                            connectionManager +FetchComponents | libp2p

                                            Interface FetchComponents

                                            interface FetchComponents {
                                                connectionManager: ConnectionManager;
                                                logger: ComponentLogger;
                                                registrar: Registrar;
                                            }

                                            Properties

                                            connectionManager logger registrar -

                                            Properties

                                            connectionManager

                                            connectionManager: ConnectionManager

                                            logger

                                            logger: ComponentLogger

                                            registrar

                                            registrar: Registrar

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            connectionManagerloggerregistrar
                                            \ No newline at end of file +

                                            Properties

                                            connectionManager

                                            connectionManager: ConnectionManager

                                            logger

                                            logger: ComponentLogger

                                            registrar

                                            registrar: Registrar

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            connectionManagerloggerregistrar
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_fetch.FetchInit.html b/interfaces/_libp2p_fetch.FetchInit.html index 0376ecefe1..55fc2bcaa9 100644 --- a/interfaces/_libp2p_fetch.FetchInit.html +++ b/interfaces/_libp2p_fetch.FetchInit.html @@ -1,6 +1,6 @@ -FetchInit | libp2p

                                            Interface FetchInit

                                            interface FetchInit {
                                                maxInboundStreams?: number;
                                                maxOutboundStreams?: number;
                                                protocolPrefix?: string;
                                                timeout?: number;
                                            }

                                            Properties

                                            maxInboundStreams? +FetchInit | libp2p

                                            Interface FetchInit

                                            interface FetchInit {
                                                maxInboundStreams?: number;
                                                maxOutboundStreams?: number;
                                                protocolPrefix?: string;
                                                timeout?: number;
                                            }

                                            Properties

                                            maxInboundStreams? maxOutboundStreams? protocolPrefix? timeout? -

                                            Properties

                                            Optional maxInboundStreams

                                            maxInboundStreams?: number

                                            Optional maxOutboundStreams

                                            maxOutboundStreams?: number

                                            Optional protocolPrefix

                                            protocolPrefix?: string

                                            Optional timeout

                                            timeout?: number

                                            How long we should wait for a remote peer to send any data

                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            maxInboundStreamsmaxOutboundStreamsprotocolPrefixtimeout
                                            \ No newline at end of file +

                                            Properties

                                            Optional maxInboundStreams

                                            maxInboundStreams?: number

                                            Optional maxOutboundStreams

                                            maxOutboundStreams?: number

                                            Optional protocolPrefix

                                            protocolPrefix?: string

                                            Optional timeout

                                            timeout?: number

                                            How long we should wait for a remote peer to send any data

                                            +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            maxInboundStreamsmaxOutboundStreamsprotocolPrefixtimeout
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_fetch.LookupFunction.html b/interfaces/_libp2p_fetch.LookupFunction.html index 4a06deb830..e1f464e99d 100644 --- a/interfaces/_libp2p_fetch.LookupFunction.html +++ b/interfaces/_libp2p_fetch.LookupFunction.html @@ -1,4 +1,4 @@ LookupFunction | libp2p

                                            Interface LookupFunction

                                            A lookup function is registered against a specific identifier prefix and is invoked when a remote peer requests a value with that prefix

                                            interface LookupFunction ((key) => Promise<undefined | Uint8Array>)

                                            Settings

                                            Member Visibility

                                            Theme

                                            \ No newline at end of file +

                                            Parameters

                                            Returns Promise<undefined | Uint8Array>

                                            Settings

                                            Member Visibility

                                            Theme

                                            \ No newline at end of file diff --git a/interfaces/_libp2p_floodsub.FloodSubComponents.html b/interfaces/_libp2p_floodsub.FloodSubComponents.html index 4c55d16625..f0413b771d 100644 --- a/interfaces/_libp2p_floodsub.FloodSubComponents.html +++ b/interfaces/_libp2p_floodsub.FloodSubComponents.html @@ -1,4 +1,4 @@ -FloodSubComponents | libp2p

                                            Interface FloodSubComponents

                                            interface FloodSubComponents {
                                                logger: ComponentLogger;
                                                peerId: PeerId;
                                                privateKey: PrivateKey;
                                                registrar: Registrar;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            logger +FloodSubComponents | libp2p

                                            Interface FloodSubComponents

                                            interface FloodSubComponents {
                                                logger: ComponentLogger;
                                                peerId: PeerId;
                                                privateKey: PrivateKey;
                                                registrar: Registrar;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            logger peerId privateKey registrar diff --git a/interfaces/_libp2p_floodsub.FloodSubInit.html b/interfaces/_libp2p_floodsub.FloodSubInit.html index e8c2ce2a19..e0b55593f8 100644 --- a/interfaces/_libp2p_floodsub.FloodSubInit.html +++ b/interfaces/_libp2p_floodsub.FloodSubInit.html @@ -1,4 +1,4 @@ -FloodSubInit | libp2p

                                            Interface FloodSubInit

                                            interface FloodSubInit {
                                                canRelayMessage?: boolean;
                                                emitSelf?: boolean;
                                                enabled?: boolean;
                                                globalSignaturePolicy?: SignaturePolicy;
                                                maxInboundStreams?: number;
                                                maxOutboundStreams?: number;
                                                messageProcessingConcurrency?: number;
                                                multicodecs?: string[];
                                                seenTTL?: number;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            canRelayMessage? +FloodSubInit | libp2p

                                            Interface FloodSubInit

                                            interface FloodSubInit {
                                                canRelayMessage?: boolean;
                                                emitSelf?: boolean;
                                                enabled?: boolean;
                                                globalSignaturePolicy?: SignaturePolicy;
                                                maxInboundStreams?: number;
                                                maxOutboundStreams?: number;
                                                messageProcessingConcurrency?: number;
                                                multicodecs?: string[];
                                                seenTTL?: number;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            canRelayMessage? emitSelf? enabled? globalSignaturePolicy? @@ -13,4 +13,4 @@

                                            Optional maxInboundStreams

                                            maxInboundStreams?: number

                                            How many parallel incoming streams to allow on the pubsub protocol per-connection

                                            Optional maxOutboundStreams

                                            maxOutboundStreams?: number

                                            How many parallel outgoing streams to allow on the pubsub protocol per-connection

                                            Optional messageProcessingConcurrency

                                            messageProcessingConcurrency?: number

                                            handle this many incoming pubsub messages concurrently

                                            -

                                            Optional multicodecs

                                            multicodecs?: string[]

                                            Optional seenTTL

                                            seenTTL?: number

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            canRelayMessageemitSelfenabledglobalSignaturePolicymaxInboundStreamsmaxOutboundStreamsmessageProcessingConcurrencymulticodecsseenTTL
                                            \ No newline at end of file +

                                            Optional multicodecs

                                            multicodecs?: string[]

                                            Optional seenTTL

                                            seenTTL?: number

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            canRelayMessageemitSelfenabledglobalSignaturePolicymaxInboundStreamsmaxOutboundStreamsmessageProcessingConcurrencymulticodecsseenTTL
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_identify.Identify.html b/interfaces/_libp2p_identify.Identify.html index d85284f798..d9315b029f 100644 --- a/interfaces/_libp2p_identify.Identify.html +++ b/interfaces/_libp2p_identify.Identify.html @@ -1,7 +1,7 @@ -Identify | libp2p

                                            Interface Identify

                                            interface Identify {
                                                identify(connection, options?): Promise<IdentifyResult>;
                                            }

                                            Methods

                                            identify +Identify | libp2p

                                            Interface Identify

                                            interface Identify {
                                                identify(connection, options?): Promise<IdentifyResult>;
                                            }

                                            Methods

                                            identify

                                            Methods

                                            identify

                                            • identify(connection, options?): Promise<IdentifyResult>

                                            • due to the default limits on inbound/outbound streams for this protocol, invoking this method when runOnConnectionOpen is true can lead to unpredictable results as streams may be closed by the local or the remote node. Please use with caution. If you find yourself needing to call this method to discover other peers that support your protocol, you may be better off configuring a topology to be notified instead.

                                              -

                                              Parameters

                                              Returns Promise<IdentifyResult>

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            identify
                                            \ No newline at end of file +

                                            Parameters

                                            Returns Promise<IdentifyResult>

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            identify
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_identify.IdentifyComponents.html b/interfaces/_libp2p_identify.IdentifyComponents.html index 03c1c2386c..7652eb82f3 100644 --- a/interfaces/_libp2p_identify.IdentifyComponents.html +++ b/interfaces/_libp2p_identify.IdentifyComponents.html @@ -1,4 +1,4 @@ -IdentifyComponents | libp2p

                                            Interface IdentifyComponents

                                            interface IdentifyComponents {
                                                addressManager: AddressManager;
                                                events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                logger: ComponentLogger;
                                                nodeInfo: NodeInfo;
                                                peerId: PeerId;
                                                peerStore: PeerStore;
                                                privateKey: PrivateKey;
                                                registrar: Registrar;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            addressManager +IdentifyComponents | libp2p

                                            Interface IdentifyComponents

                                            interface IdentifyComponents {
                                                addressManager: AddressManager;
                                                events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                logger: ComponentLogger;
                                                nodeInfo: NodeInfo;
                                                peerId: PeerId;
                                                peerStore: PeerStore;
                                                privateKey: PrivateKey;
                                                registrar: Registrar;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            addressManager events logger nodeInfo @@ -6,4 +6,4 @@ peerStore privateKey registrar -

                                            Properties

                                            addressManager

                                            addressManager: AddressManager

                                            events

                                            events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                            logger

                                            logger: ComponentLogger

                                            nodeInfo

                                            nodeInfo: NodeInfo

                                            peerId

                                            peerId: PeerId

                                            peerStore

                                            peerStore: PeerStore

                                            privateKey

                                            privateKey: PrivateKey

                                            registrar

                                            registrar: Registrar

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            addressManagereventsloggernodeInfopeerIdpeerStoreprivateKeyregistrar
                                            \ No newline at end of file +

                                            Properties

                                            addressManager

                                            addressManager: AddressManager

                                            events

                                            events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                            logger

                                            logger: ComponentLogger

                                            nodeInfo

                                            nodeInfo: NodeInfo

                                            peerId

                                            peerId: PeerId

                                            peerStore

                                            peerStore: PeerStore

                                            privateKey

                                            privateKey: PrivateKey

                                            registrar

                                            registrar: Registrar

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            addressManagereventsloggernodeInfopeerIdpeerStoreprivateKeyregistrar
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_identify.IdentifyInit.html b/interfaces/_libp2p_identify.IdentifyInit.html index b1e247da2b..50fd38ec55 100644 --- a/interfaces/_libp2p_identify.IdentifyInit.html +++ b/interfaces/_libp2p_identify.IdentifyInit.html @@ -1,4 +1,4 @@ -IdentifyInit | libp2p

                                            Interface IdentifyInit

                                            interface IdentifyInit {
                                                agentVersion?: string;
                                                maxInboundStreams?: number;
                                                maxMessageSize?: number;
                                                maxObservedAddresses?: number;
                                                maxOutboundStreams?: number;
                                                protocolPrefix?: string;
                                                runOnConnectionOpen?: boolean;
                                                runOnLimitedConnection?: boolean;
                                                timeout?: number;
                                            }

                                            Properties

                                            agentVersion? +IdentifyInit | libp2p

                                            Interface IdentifyInit

                                            interface IdentifyInit {
                                                agentVersion?: string;
                                                maxInboundStreams?: number;
                                                maxMessageSize?: number;
                                                maxObservedAddresses?: number;
                                                maxOutboundStreams?: number;
                                                protocolPrefix?: string;
                                                runOnConnectionOpen?: boolean;
                                                runOnLimitedConnection?: boolean;
                                                timeout?: number;
                                            }

                                            Properties

                                            agentVersion? maxInboundStreams? maxMessageSize? maxObservedAddresses? @@ -8,28 +8,28 @@ runOnLimitedConnection? timeout?

                                            Properties

                                            Optional agentVersion

                                            agentVersion?: string

                                            What details we should send as part of an identify message

                                            -

                                            Optional maxInboundStreams

                                            maxInboundStreams?: number

                                            The maximum number of inbound streams that may be open on a single +

                                            Optional maxInboundStreams

                                            maxInboundStreams?: number

                                            The maximum number of inbound streams that may be open on a single connection for this protocol

                                            Default

                                            1
                                            -

                                            Optional maxMessageSize

                                            maxMessageSize?: number

                                            Identify responses larger than this in bytes will be rejected

                                            +

                                            Optional maxMessageSize

                                            maxMessageSize?: number

                                            Identify responses larger than this in bytes will be rejected

                                            Default

                                            8192
                                            -

                                            Optional maxObservedAddresses

                                            maxObservedAddresses?: number

                                            The maximum number of observed addresses to send in an Identify message

                                            -

                                            Optional maxOutboundStreams

                                            maxOutboundStreams?: number

                                            The maximum number of outbound streams that may be open on a single +

                                            Optional maxObservedAddresses

                                            maxObservedAddresses?: number

                                            The maximum number of observed addresses to send in an Identify message

                                            +

                                            Optional maxOutboundStreams

                                            maxOutboundStreams?: number

                                            The maximum number of outbound streams that may be open on a single connection for this protocol

                                            Default

                                            1
                                            -

                                            Optional protocolPrefix

                                            protocolPrefix?: string

                                            The prefix to use for the protocol

                                            +

                                            Optional protocolPrefix

                                            protocolPrefix?: string

                                            The prefix to use for the protocol

                                            Default

                                            'ipfs'
                                            -

                                            Optional runOnConnectionOpen

                                            runOnConnectionOpen?: boolean

                                            Whether to automatically run identify on newly opened connections

                                            +

                                            Optional runOnConnectionOpen

                                            runOnConnectionOpen?: boolean

                                            Whether to automatically run identify on newly opened connections

                                            Default

                                            true
                                            -

                                            Optional runOnLimitedConnection

                                            runOnLimitedConnection?: boolean

                                            Whether to run on connections with data or duration limits

                                            +

                                            Optional runOnLimitedConnection

                                            runOnLimitedConnection?: boolean

                                            Whether to run on connections with data or duration limits

                                            Default

                                            true
                                            -

                                            Optional timeout

                                            timeout?: number

                                            How long we should wait for a remote peer to send their identify response

                                            +

                                            Optional timeout

                                            timeout?: number

                                            How long we should wait for a remote peer to send their identify response

                                            Default

                                            5000
                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            agentVersionmaxInboundStreamsmaxMessageSizemaxObservedAddressesmaxOutboundStreamsprotocolPrefixrunOnConnectionOpenrunOnLimitedConnectiontimeout
                                            \ No newline at end of file +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            agentVersionmaxInboundStreamsmaxMessageSizemaxObservedAddressesmaxOutboundStreamsprotocolPrefixrunOnConnectionOpenrunOnLimitedConnectiontimeout
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_identify.IdentifyPush.html b/interfaces/_libp2p_identify.IdentifyPush.html index 77165afc4a..db963bf8f7 100644 --- a/interfaces/_libp2p_identify.IdentifyPush.html +++ b/interfaces/_libp2p_identify.IdentifyPush.html @@ -1,2 +1,2 @@ -IdentifyPush | libp2p

                                            Interface IdentifyPush

                                            interface IdentifyPush {
                                                push(): Promise<void>;
                                            }

                                            Methods

                                            push -

                                            Methods

                                            push

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            push
                                            \ No newline at end of file +IdentifyPush | libp2p

                                            Interface IdentifyPush

                                            interface IdentifyPush {
                                                push(): Promise<void>;
                                            }

                                            Methods

                                            push +

                                            Methods

                                            push

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            push
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_identify.IdentifyPushComponents.html b/interfaces/_libp2p_identify.IdentifyPushComponents.html index 2c771c6150..6ec04a5a28 100644 --- a/interfaces/_libp2p_identify.IdentifyPushComponents.html +++ b/interfaces/_libp2p_identify.IdentifyPushComponents.html @@ -1,4 +1,4 @@ -IdentifyPushComponents | libp2p

                                            Interface IdentifyPushComponents

                                            interface IdentifyPushComponents {
                                                addressManager: AddressManager;
                                                connectionManager: ConnectionManager;
                                                events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                logger: ComponentLogger;
                                                nodeInfo: NodeInfo;
                                                peerId: PeerId;
                                                peerStore: PeerStore;
                                                privateKey: PrivateKey;
                                                registrar: Registrar;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            addressManager +IdentifyPushComponents | libp2p

                                            Interface IdentifyPushComponents

                                            interface IdentifyPushComponents {
                                                addressManager: AddressManager;
                                                connectionManager: ConnectionManager;
                                                events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                logger: ComponentLogger;
                                                nodeInfo: NodeInfo;
                                                peerId: PeerId;
                                                peerStore: PeerStore;
                                                privateKey: PrivateKey;
                                                registrar: Registrar;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            addressManager connectionManager events logger @@ -7,4 +7,4 @@ peerStore privateKey registrar -

                                            Properties

                                            addressManager

                                            addressManager: AddressManager

                                            connectionManager

                                            connectionManager: ConnectionManager

                                            events

                                            events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                            logger

                                            logger: ComponentLogger

                                            nodeInfo

                                            nodeInfo: NodeInfo

                                            peerId

                                            peerId: PeerId

                                            peerStore

                                            peerStore: PeerStore

                                            privateKey

                                            privateKey: PrivateKey

                                            registrar

                                            registrar: Registrar

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            addressManagerconnectionManagereventsloggernodeInfopeerIdpeerStoreprivateKeyregistrar
                                            \ No newline at end of file +

                                            Properties

                                            addressManager

                                            addressManager: AddressManager

                                            connectionManager

                                            connectionManager: ConnectionManager

                                            events

                                            events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                            logger

                                            logger: ComponentLogger

                                            nodeInfo

                                            nodeInfo: NodeInfo

                                            peerId

                                            peerId: PeerId

                                            peerStore

                                            peerStore: PeerStore

                                            privateKey

                                            privateKey: PrivateKey

                                            registrar

                                            registrar: Registrar

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            addressManagerconnectionManagereventsloggernodeInfopeerIdpeerStoreprivateKeyregistrar
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_identify.IdentifyPushInit.html b/interfaces/_libp2p_identify.IdentifyPushInit.html index 1a22060eb5..ecf9ca2313 100644 --- a/interfaces/_libp2p_identify.IdentifyPushInit.html +++ b/interfaces/_libp2p_identify.IdentifyPushInit.html @@ -1,4 +1,4 @@ -IdentifyPushInit | libp2p

                                            Interface IdentifyPushInit

                                            interface IdentifyPushInit {
                                                agentVersion?: string;
                                                concurrency?: number;
                                                maxInboundStreams?: number;
                                                maxMessageSize?: number;
                                                maxObservedAddresses?: number;
                                                maxOutboundStreams?: number;
                                                protocolPrefix?: string;
                                                runOnLimitedConnection?: boolean;
                                                runOnSelfUpdate?: boolean;
                                                timeout?: number;
                                            }

                                            Hierarchy

                                            Properties

                                            agentVersion? +IdentifyPushInit | libp2p

                                            Interface IdentifyPushInit

                                            interface IdentifyPushInit {
                                                agentVersion?: string;
                                                concurrency?: number;
                                                maxInboundStreams?: number;
                                                maxMessageSize?: number;
                                                maxObservedAddresses?: number;
                                                maxOutboundStreams?: number;
                                                protocolPrefix?: string;
                                                runOnLimitedConnection?: boolean;
                                                runOnSelfUpdate?: boolean;
                                                timeout?: number;
                                            }

                                            Hierarchy

                                            Properties

                                            agentVersion? concurrency? maxInboundStreams? maxMessageSize? @@ -9,31 +9,31 @@ runOnSelfUpdate? timeout?

                                            Properties

                                            Optional agentVersion

                                            agentVersion?: string

                                            What details we should send as part of an identify message

                                            -

                                            Optional concurrency

                                            concurrency?: number

                                            Push to this many connections in parallel

                                            +

                                            Optional concurrency

                                            concurrency?: number

                                            Push to this many connections in parallel

                                            Default

                                            32
                                            -

                                            Optional maxInboundStreams

                                            maxInboundStreams?: number

                                            The maximum number of inbound streams that may be open on a single +

                                            Optional maxInboundStreams

                                            maxInboundStreams?: number

                                            The maximum number of inbound streams that may be open on a single connection for this protocol

                                            Default

                                            1
                                            -

                                            Optional maxMessageSize

                                            maxMessageSize?: number

                                            Identify responses larger than this in bytes will be rejected

                                            +

                                            Optional maxMessageSize

                                            maxMessageSize?: number

                                            Identify responses larger than this in bytes will be rejected

                                            Default

                                            8192
                                            -

                                            Optional maxObservedAddresses

                                            maxObservedAddresses?: number

                                            The maximum number of observed addresses to send in an Identify message

                                            -

                                            Optional maxOutboundStreams

                                            maxOutboundStreams?: number

                                            The maximum number of outbound streams that may be open on a single +

                                            Optional maxObservedAddresses

                                            maxObservedAddresses?: number

                                            The maximum number of observed addresses to send in an Identify message

                                            +

                                            Optional maxOutboundStreams

                                            maxOutboundStreams?: number

                                            The maximum number of outbound streams that may be open on a single connection for this protocol

                                            Default

                                            1
                                            -

                                            Optional protocolPrefix

                                            protocolPrefix?: string

                                            The prefix to use for the protocol

                                            +

                                            Optional protocolPrefix

                                            protocolPrefix?: string

                                            The prefix to use for the protocol

                                            Default

                                            'ipfs'
                                            -

                                            Optional runOnLimitedConnection

                                            runOnLimitedConnection?: boolean

                                            Whether to run on connections with data or duration limits

                                            +

                                            Optional runOnLimitedConnection

                                            runOnLimitedConnection?: boolean

                                            Whether to run on connections with data or duration limits

                                            Default

                                            true
                                            -

                                            Optional runOnSelfUpdate

                                            runOnSelfUpdate?: boolean

                                            Whether to automatically dial identify-push on self updates

                                            +

                                            Optional runOnSelfUpdate

                                            runOnSelfUpdate?: boolean

                                            Whether to automatically dial identify-push on self updates

                                            Default

                                            true
                                            -

                                            Optional timeout

                                            timeout?: number

                                            How long we should wait for a remote peer to send their identify response

                                            +

                                            Optional timeout

                                            timeout?: number

                                            How long we should wait for a remote peer to send their identify response

                                            Default

                                            5000
                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            agentVersionconcurrencymaxInboundStreamsmaxMessageSizemaxObservedAddressesmaxOutboundStreamsprotocolPrefixrunOnLimitedConnectionrunOnSelfUpdatetimeout
                                            \ No newline at end of file +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            agentVersionconcurrencymaxInboundStreamsmaxMessageSizemaxObservedAddressesmaxOutboundStreamsprotocolPrefixrunOnLimitedConnectionrunOnSelfUpdatetimeout
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.AbortOptions.html b/interfaces/_libp2p_interface.AbortOptions.html index 9bfea262c6..59783e90f4 100644 --- a/interfaces/_libp2p_interface.AbortOptions.html +++ b/interfaces/_libp2p_interface.AbortOptions.html @@ -2,5 +2,5 @@ the optional signal property.

                                            Example

                                            const controller = new AbortController()

                                            aLongRunningOperation({
                                              signal: controller.signal
                                            })

                                            // later

                                            controller.abort()
                                            -
                                            interface AbortOptions {
                                                signal?: AbortSignal;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            signal? -

                                            Properties

                                            Optional signal

                                            signal?: AbortSignal

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            signal
                                            \ No newline at end of file +
                                            interface AbortOptions {
                                                signal?: AbortSignal;
                                            }

                                            Hierarchy (view full)

                                            Properties

                                            signal? +

                                            Properties

                                            Optional signal

                                            signal?: AbortSignal

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            signal
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Address.html b/interfaces/_libp2p_interface.Address.html index 4407a5ad41..0083b7bab6 100644 --- a/interfaces/_libp2p_interface.Address.html +++ b/interfaces/_libp2p_interface.Address.html @@ -1,6 +1,6 @@ Address | libp2p

                                            Interface Address

                                            A multiaddr with an optional flag that indicates if its trustworthy

                                            -
                                            interface Address {
                                                isCertified: boolean;
                                                multiaddr: Multiaddr;
                                            }

                                            Properties

                                            isCertified +
                                            interface Address {
                                                isCertified: boolean;
                                                multiaddr: Multiaddr;
                                            }

                                            Properties

                                            isCertified multiaddr

                                            Properties

                                            isCertified

                                            isCertified: boolean

                                            Obtained from a signed peer record

                                            -

                                            multiaddr

                                            multiaddr: Multiaddr

                                            Peer multiaddr

                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            isCertifiedmultiaddr
                                            \ No newline at end of file +

                                            multiaddr

                                            multiaddr: Multiaddr

                                            Peer multiaddr

                                            +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            isCertifiedmultiaddr
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.AddressSorter.html b/interfaces/_libp2p_interface.AddressSorter.html index fd5ffa4386..71df69b3e8 100644 --- a/interfaces/_libp2p_interface.AddressSorter.html +++ b/interfaces/_libp2p_interface.AddressSorter.html @@ -1,2 +1,2 @@ AddressSorter | libp2p

                                            Interface AddressSorter

                                            Used by the connection manager to sort addresses into order before dialling

                                            -
                                            interface AddressSorter ((a, b) => -1 | 0 | 1)

                                            Settings

                                            Member Visibility

                                            Theme

                                            \ No newline at end of file +
                                            interface AddressSorter ((a, b) => -1 | 0 | 1)

                                            Settings

                                            Member Visibility

                                            Theme

                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.CalculatedHistogramOptions.html b/interfaces/_libp2p_interface.CalculatedHistogramOptions.html index 8e372c79a6..ee29df9471 100644 --- a/interfaces/_libp2p_interface.CalculatedHistogramOptions.html +++ b/interfaces/_libp2p_interface.CalculatedHistogramOptions.html @@ -1,12 +1,12 @@ CalculatedHistogramOptions | libp2p

                                            Interface CalculatedHistogramOptions<T>

                                            Create tracked metrics that are expensive to calculate by passing a function that is only invoked when metrics are being scraped

                                            -
                                            interface CalculatedHistogramOptions<T> {
                                                buckets?: number[];
                                                calculate: CalculateMetric<T>;
                                                help?: string;
                                                label?: string;
                                            }

                                            Type Parameters

                                            • T = number

                                            Hierarchy (view full)

                                            Properties

                                            buckets? +
                                            interface CalculatedHistogramOptions<T> {
                                                buckets?: number[];
                                                calculate: CalculateMetric<T>;
                                                help?: string;
                                                label?: string;
                                            }

                                            Type Parameters

                                            • T = number

                                            Hierarchy (view full)

                                            Properties

                                            buckets? calculate help? label?

                                            Properties

                                            Optional buckets

                                            buckets?: number[]

                                            Buckets for the histogram

                                            -

                                            calculate

                                            calculate: CalculateMetric<T>

                                            An optional function invoked to calculate the component metric instead of +

                                            calculate

                                            calculate: CalculateMetric<T>

                                            An optional function invoked to calculate the component metric instead of using .observe

                                            -

                                            Optional help

                                            help?: string

                                            Optional help for the metric

                                            -

                                            Optional label

                                            label?: string

                                            Optional label for the metric

                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            bucketscalculatehelplabel
                                            \ No newline at end of file +

                                            Optional help

                                            help?: string

                                            Optional help for the metric

                                            +

                                            Optional label

                                            label?: string

                                            Optional label for the metric

                                            +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            bucketscalculatehelplabel
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.CalculatedMetricOptions.html b/interfaces/_libp2p_interface.CalculatedMetricOptions.html index aa600bfda7..5c345739ea 100644 --- a/interfaces/_libp2p_interface.CalculatedMetricOptions.html +++ b/interfaces/_libp2p_interface.CalculatedMetricOptions.html @@ -1,10 +1,10 @@ CalculatedMetricOptions | libp2p

                                            Interface CalculatedMetricOptions<T>

                                            Create tracked metrics that are expensive to calculate by passing a function that is only invoked when metrics are being scraped

                                            -
                                            interface CalculatedMetricOptions<T> {
                                                calculate: CalculateMetric<T>;
                                                help?: string;
                                                label?: string;
                                            }

                                            Type Parameters

                                            • T = number

                                            Hierarchy (view full)

                                            Properties

                                            calculate +
                                            interface CalculatedMetricOptions<T> {
                                                calculate: CalculateMetric<T>;
                                                help?: string;
                                                label?: string;
                                            }

                                            Type Parameters

                                            • T = number

                                            Hierarchy (view full)

                                            Properties

                                            calculate help? label?

                                            Properties

                                            calculate

                                            calculate: CalculateMetric<T>

                                            An optional function invoked to calculate the component metric instead of using .update, .increment, and .decrement

                                            -

                                            Optional help

                                            help?: string

                                            Optional help for the metric

                                            -

                                            Optional label

                                            label?: string

                                            Optional label for the metric

                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            calculatehelplabel
                                            \ No newline at end of file +

                                            Optional help

                                            help?: string

                                            Optional help for the metric

                                            +

                                            Optional label

                                            label?: string

                                            Optional label for the metric

                                            +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            calculatehelplabel
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.CalculatedSummaryOptions.html b/interfaces/_libp2p_interface.CalculatedSummaryOptions.html index 9fabe11131..3e49a5bf90 100644 --- a/interfaces/_libp2p_interface.CalculatedSummaryOptions.html +++ b/interfaces/_libp2p_interface.CalculatedSummaryOptions.html @@ -1,6 +1,6 @@ CalculatedSummaryOptions | libp2p

                                            Interface CalculatedSummaryOptions<T>

                                            Create tracked metrics that are expensive to calculate by passing a function that is only invoked when metrics are being scraped

                                            -
                                            interface CalculatedSummaryOptions<T> {
                                                ageBuckets?: number;
                                                calculate: CalculateMetric<T>;
                                                compressCount?: number;
                                                help?: string;
                                                label?: string;
                                                maxAgeSeconds?: number;
                                                percentiles?: number[];
                                                pruneAgedBuckets?: boolean;
                                            }

                                            Type Parameters

                                            • T = number

                                            Hierarchy (view full)

                                            Properties

                                            ageBuckets? +
                                            interface CalculatedSummaryOptions<T> {
                                                ageBuckets?: number;
                                                calculate: CalculateMetric<T>;
                                                compressCount?: number;
                                                help?: string;
                                                label?: string;
                                                maxAgeSeconds?: number;
                                                percentiles?: number[];
                                                pruneAgedBuckets?: boolean;
                                            }

                                            Type Parameters

                                            • T = number

                                            Hierarchy (view full)

                                            Properties

                                            ageBuckets? calculate compressCount? help? @@ -9,12 +9,12 @@ percentiles? pruneAgedBuckets?

                                            Properties

                                            Optional ageBuckets

                                            ageBuckets?: number

                                            Configure how many buckets in the sliding window

                                            -

                                            calculate

                                            calculate: CalculateMetric<T>

                                            An optional function invoked to calculate the component metric instead of +

                                            calculate

                                            calculate: CalculateMetric<T>

                                            An optional function invoked to calculate the component metric instead of using .observe

                                            -

                                            Optional compressCount

                                            compressCount?: number

                                            Control compression of data in t-digest

                                            -

                                            Optional help

                                            help?: string

                                            Optional help for the metric

                                            -

                                            Optional label

                                            label?: string

                                            Optional label for the metric

                                            -

                                            Optional maxAgeSeconds

                                            maxAgeSeconds?: number

                                            Configure how old a bucket can be before it is reset for sliding window

                                            -

                                            Optional percentiles

                                            percentiles?: number[]

                                            Percentiles for the summary

                                            -

                                            Optional pruneAgedBuckets

                                            pruneAgedBuckets?: boolean

                                            Remove entries without any new values in the last maxAgeSeconds

                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            ageBucketscalculatecompressCounthelplabelmaxAgeSecondspercentilespruneAgedBuckets
                                            \ No newline at end of file +

                                            Optional compressCount

                                            compressCount?: number

                                            Control compression of data in t-digest

                                            +

                                            Optional help

                                            help?: string

                                            Optional help for the metric

                                            +

                                            Optional label

                                            label?: string

                                            Optional label for the metric

                                            +

                                            Optional maxAgeSeconds

                                            maxAgeSeconds?: number

                                            Configure how old a bucket can be before it is reset for sliding window

                                            +

                                            Optional percentiles

                                            percentiles?: number[]

                                            Percentiles for the summary

                                            +

                                            Optional pruneAgedBuckets

                                            pruneAgedBuckets?: boolean

                                            Remove entries without any new values in the last maxAgeSeconds

                                            +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            ageBucketscalculatecompressCounthelplabelmaxAgeSecondspercentilespruneAgedBuckets
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.ComponentLogger.html b/interfaces/_libp2p_interface.ComponentLogger.html index b7788aab96..cd286201be 100644 --- a/interfaces/_libp2p_interface.ComponentLogger.html +++ b/interfaces/_libp2p_interface.ComponentLogger.html @@ -1,3 +1,3 @@ ComponentLogger | libp2p

                                            Interface ComponentLogger

                                            Peer logger component for libp2p

                                            -
                                            interface ComponentLogger {
                                                forComponent(name): Logger;
                                            }

                                            Methods

                                            forComponent -

                                            Methods

                                            forComponent

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            forComponent
                                            \ No newline at end of file +
                                            interface ComponentLogger {
                                                forComponent(name): Logger;
                                            }

                                            Methods

                                            forComponent +

                                            Methods

                                            forComponent

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            forComponent
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Connection.html b/interfaces/_libp2p_interface.Connection.html index 7694e63a56..8d54d418d6 100644 --- a/interfaces/_libp2p_interface.Connection.html +++ b/interfaces/_libp2p_interface.Connection.html @@ -2,7 +2,7 @@ to a remote peer that may have been secured by encryption and multiplexed, depending on the configuration of the nodes between which the connection is made.

                                            -
                                            interface Connection {
                                                direction: Direction;
                                                encryption?: string;
                                                id: string;
                                                limits?: ConnectionLimits;
                                                log: Logger;
                                                multiplexer?: string;
                                                remoteAddr: Multiaddr;
                                                remotePeer: PeerId;
                                                rtt?: number;
                                                status: ConnectionStatus;
                                                streams: Stream[];
                                                tags: string[];
                                                timeline: ConnectionTimeline;
                                                abort(err): void;
                                                close(options?): Promise<void>;
                                                newStream(protocols, options?): Promise<Stream>;
                                            }

                                            Properties

                                            direction +
                                            interface Connection {
                                                direction: Direction;
                                                encryption?: string;
                                                id: string;
                                                limits?: ConnectionLimits;
                                                log: Logger;
                                                multiplexer?: string;
                                                remoteAddr: Multiaddr;
                                                remotePeer: PeerId;
                                                rtt?: number;
                                                status: ConnectionStatus;
                                                streams: Stream[];
                                                tags: string[];
                                                timeline: ConnectionTimeline;
                                                abort(err): void;
                                                close(options?): Promise<void>;
                                                newStream(protocols, options?): Promise<Stream>;
                                            }

                                            Properties

                                            direction encryption? id limits? @@ -19,23 +19,23 @@ close newStream

                                            Properties

                                            direction

                                            direction: Direction

                                            Outbound conections are opened by the local node, inbound streams are opened by the remote

                                            -

                                            Optional encryption

                                            encryption?: string

                                            The encryption protocol negotiated for this connection

                                            -

                                            id

                                            id: string

                                            The unique identifier for this connection

                                            -

                                            Optional limits

                                            limits?: ConnectionLimits

                                            If present, this connection has limits applied to it, perhaps by an +

                                            Optional encryption

                                            encryption?: string

                                            The encryption protocol negotiated for this connection

                                            +

                                            id

                                            id: string

                                            The unique identifier for this connection

                                            +

                                            Optional limits

                                            limits?: ConnectionLimits

                                            If present, this connection has limits applied to it, perhaps by an intermediate relay. Once the limits have been reached the connection will be closed by the relay.

                                            -

                                            log

                                            log: Logger

                                            The connection logger

                                            -

                                            Optional multiplexer

                                            multiplexer?: string

                                            The multiplexer negotiated for this connection

                                            -

                                            remoteAddr

                                            remoteAddr: Multiaddr

                                            The address of the remote end of the connection

                                            -

                                            remotePeer

                                            remotePeer: PeerId

                                            The id of the peer at the remote end of the connection

                                            -

                                            Optional rtt

                                            rtt?: number

                                            The time in milliseconds it takes to make a round trip to the remote peer.

                                            +

                                            log

                                            log: Logger

                                            The connection logger

                                            +

                                            Optional multiplexer

                                            multiplexer?: string

                                            The multiplexer negotiated for this connection

                                            +

                                            remoteAddr

                                            remoteAddr: Multiaddr

                                            The address of the remote end of the connection

                                            +

                                            remotePeer

                                            remotePeer: PeerId

                                            The id of the peer at the remote end of the connection

                                            +

                                            Optional rtt

                                            rtt?: number

                                            The time in milliseconds it takes to make a round trip to the remote peer.

                                            This is updated periodically by the connection monitor.

                                            -

                                            status

                                            status: ConnectionStatus

                                            The current status of the connection

                                            -

                                            streams

                                            streams: Stream[]

                                            A list of open streams on this connection

                                            -

                                            tags

                                            tags: string[]

                                            A list of tags applied to this connection

                                            -

                                            timeline

                                            timeline: ConnectionTimeline

                                            Lifecycle times for the connection

                                            -

                                            Methods

                                            abort

                                            close

                                            status

                                            status: ConnectionStatus

                                            The current status of the connection

                                            +

                                            streams

                                            streams: Stream[]

                                            A list of open streams on this connection

                                            +

                                            tags

                                            tags: string[]

                                            A list of tags applied to this connection

                                            +

                                            timeline

                                            timeline: ConnectionTimeline

                                            Lifecycle times for the connection

                                            +

                                            Methods

                                            abort

                                            close

                                            newStream

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            directionencryptionidlimitslogmultiplexerremoteAddrremotePeerrttstatusstreamstagstimelineabortclosenewStream
                                            \ No newline at end of file +

                                            Parameters

                                            Returns Promise<void>

                                            newStream

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            directionencryptionidlimitslogmultiplexerremoteAddrremotePeerrttstatusstreamstagstimelineabortclosenewStream
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.ConnectionEncrypter.html b/interfaces/_libp2p_interface.ConnectionEncrypter.html index dcdee77990..21c3b02647 100644 --- a/interfaces/_libp2p_interface.ConnectionEncrypter.html +++ b/interfaces/_libp2p_interface.ConnectionEncrypter.html @@ -1,12 +1,12 @@ ConnectionEncrypter | libp2p

                                            Interface ConnectionEncrypter<Extension>

                                            A libp2p connection encrypter module must be compliant to this interface to ensure all exchanged data between two peers is encrypted.

                                            -
                                            interface ConnectionEncrypter<Extension> {
                                                protocol: string;
                                                secureInbound<Stream>(connection, options?): Promise<SecuredConnection<Stream, Extension>>;
                                                secureOutbound<Stream>(connection, options?): Promise<SecuredConnection<Stream, Extension>>;
                                            }

                                            Type Parameters

                                            • Extension = unknown

                                            Properties

                                            protocol +
                                            interface ConnectionEncrypter<Extension> {
                                                protocol: string;
                                                secureInbound<Stream>(connection, options?): Promise<SecuredConnection<Stream, Extension>>;
                                                secureOutbound<Stream>(connection, options?): Promise<SecuredConnection<Stream, Extension>>;
                                            }

                                            Type Parameters

                                            • Extension = unknown

                                            Properties

                                            protocol

                                            Methods

                                            secureInbound secureOutbound -

                                            Properties

                                            protocol

                                            protocol: string

                                            Methods

                                            secureInbound

                                            Properties

                                            protocol

                                            protocol: string

                                            Methods

                                            secureInbound

                                            secureOutbound

                                            secureOutbound

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            protocolsecureInboundsecureOutbound
                                            \ No newline at end of file +

                                            Type Parameters

                                            Parameters

                                            Returns Promise<SecuredConnection<Stream, Extension>>

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            protocolsecureInboundsecureOutbound
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.ConnectionGater.html b/interfaces/_libp2p_interface.ConnectionGater.html index aeb37387b9..5c97410ab8 100644 --- a/interfaces/_libp2p_interface.ConnectionGater.html +++ b/interfaces/_libp2p_interface.ConnectionGater.html @@ -1,4 +1,4 @@ -ConnectionGater | libp2p

                                            Interface ConnectionGater

                                            interface ConnectionGater {
                                                denyDialMultiaddr?(multiaddr): boolean | Promise<boolean>;
                                                denyDialPeer?(peerId): boolean | Promise<boolean>;
                                                denyInboundConnection?(maConn): boolean | Promise<boolean>;
                                                denyInboundEncryptedConnection?(peerId, maConn): boolean | Promise<boolean>;
                                                denyInboundRelayReservation?(source): boolean | Promise<boolean>;
                                                denyInboundRelayedConnection?(relay, remotePeer): boolean | Promise<boolean>;
                                                denyInboundUpgradedConnection?(peerId, maConn): boolean | Promise<boolean>;
                                                denyOutboundConnection?(peerId, maConn): boolean | Promise<boolean>;
                                                denyOutboundEncryptedConnection?(peerId, maConn): boolean | Promise<boolean>;
                                                denyOutboundRelayedConnection?(source, destination): boolean | Promise<boolean>;
                                                denyOutboundUpgradedConnection?(peerId, maConn): boolean | Promise<boolean>;
                                                filterMultiaddrForPeer?(peer, multiaddr): boolean | Promise<boolean>;
                                            }

                                            Methods

                                            denyDialMultiaddr? +ConnectionGater | libp2p

                                            Interface ConnectionGater

                                            interface ConnectionGater {
                                                denyDialMultiaddr?(multiaddr): boolean | Promise<boolean>;
                                                denyDialPeer?(peerId): boolean | Promise<boolean>;
                                                denyInboundConnection?(maConn): boolean | Promise<boolean>;
                                                denyInboundEncryptedConnection?(peerId, maConn): boolean | Promise<boolean>;
                                                denyInboundRelayReservation?(source): boolean | Promise<boolean>;
                                                denyInboundRelayedConnection?(relay, remotePeer): boolean | Promise<boolean>;
                                                denyInboundUpgradedConnection?(peerId, maConn): boolean | Promise<boolean>;
                                                denyOutboundConnection?(peerId, maConn): boolean | Promise<boolean>;
                                                denyOutboundEncryptedConnection?(peerId, maConn): boolean | Promise<boolean>;
                                                denyOutboundRelayedConnection?(source, destination): boolean | Promise<boolean>;
                                                denyOutboundUpgradedConnection?(peerId, maConn): boolean | Promise<boolean>;
                                                filterMultiaddrForPeer?(peer, multiaddr): boolean | Promise<boolean>;
                                            }

                                            Methods

                                            denyDialMultiaddr? denyDialPeer? denyInboundConnection? denyInboundEncryptedConnection? @@ -15,52 +15,52 @@

                                            This is called by the connection manager - if the peer id of the remote node is known it will be present in the multiaddr.

                                            Return true to prevent dialing the passed peer on the passed multiaddr.

                                            -

                                            Parameters

                                            Returns boolean | Promise<boolean>

                                            Optional denyDialPeer

                                            Optional denyDialPeer

                                            • denyDialPeer(peerId): boolean | Promise<boolean>

                                            • denyDialPeer tests whether we're permitted to Dial the specified peer.

                                              This is called by the dialer.connectToPeer implementation before dialling a peer.

                                              Return true to prevent dialing the passed peer.

                                              -

                                              Parameters

                                              Returns boolean | Promise<boolean>

                                            Optional denyInboundConnection

                                            Optional denyInboundConnection

                                            • denyInboundConnection(maConn): boolean | Promise<boolean>

                                            • denyInboundConnection tests whether an incipient inbound connection is allowed.

                                              This is called by the upgrader, or by the transport directly (e.g. QUIC, Bluetooth), straight after it has accepted a connection from its socket.

                                              Return true to deny the incoming passed connection.

                                              -

                                              Parameters

                                              Returns boolean | Promise<boolean>

                                            Optional denyInboundEncryptedConnection

                                            Optional denyInboundEncryptedConnection

                                            • denyInboundEncryptedConnection(peerId, maConn): boolean | Promise<boolean>

                                            • denyInboundEncryptedConnection tests whether a given connection, now encrypted, is allowed.

                                              This is called by the upgrader, after it has performed the security handshake, and before it negotiates the muxer, or by the directly by the transport, at the exact same checkpoint.

                                              Return true to deny the passed secured connection.

                                              -

                                              Parameters

                                              Returns boolean | Promise<boolean>

                                            Optional denyInboundRelayReservation

                                            Optional denyInboundRelayReservation

                                            Optional denyInboundRelayedConnection

                                            Optional denyInboundRelayedConnection

                                            • denyInboundRelayedConnection(relay, remotePeer): boolean | Promise<boolean>

                                            • denyInboundRelayedConnection tests whether a remote peer is allowed to open a relayed connection to this node.

                                              This is invoked on the relay client when a remote relay has received an instruction to relay a connection to the client.

                                              Return true to deny the relayed connection.

                                              -

                                              Parameters

                                              Returns boolean | Promise<boolean>

                                            Optional denyInboundUpgradedConnection

                                            Optional denyInboundUpgradedConnection

                                            • denyInboundUpgradedConnection(peerId, maConn): boolean | Promise<boolean>

                                            • denyInboundUpgradedConnection tests whether a fully capable connection is allowed.

                                              This is called after encryption has been negotiated and the connection has been multiplexed, if a multiplexer is configured.

                                              Return true to deny the passed upgraded connection.

                                              -

                                              Parameters

                                              Returns boolean | Promise<boolean>

                                            Optional denyOutboundConnection

                                            Optional denyOutboundConnection

                                            • denyOutboundConnection(peerId, maConn): boolean | Promise<boolean>

                                            • denyOutboundConnection tests whether an incipient outbound connection is allowed.

                                              This is called by the upgrader, or by the transport directly (e.g. QUIC, Bluetooth), straight after it has created a connection with its socket.

                                              Return true to deny the incoming passed connection.

                                              -

                                              Parameters

                                              Returns boolean | Promise<boolean>

                                            Optional denyOutboundEncryptedConnection

                                            Optional denyOutboundEncryptedConnection

                                            • denyOutboundEncryptedConnection(peerId, maConn): boolean | Promise<boolean>

                                            • denyOutboundEncryptedConnection tests whether a given connection, now encrypted, is allowed.

                                              This is called by the upgrader, after it has performed the security handshake, and before it negotiates the muxer, or by the directly by the transport, at the exact same checkpoint.

                                              Return true to deny the passed secured connection.

                                              -

                                              Parameters

                                              Returns boolean | Promise<boolean>

                                            Optional denyOutboundRelayedConnection

                                            Optional denyOutboundRelayedConnection

                                            • denyOutboundRelayedConnection(source, destination): boolean | Promise<boolean>

                                            • denyOutboundRelayedConnection tests whether a remote peer is allowed to open a relayed connection to the destination node.

                                              This is invoked on the relay server when a source client with a reservation instructs the server to relay a connection to a destination peer.

                                              Return true to deny the relayed connection.

                                              -

                                              Parameters

                                              Returns boolean | Promise<boolean>

                                            Optional denyOutboundUpgradedConnection

                                            Optional denyOutboundUpgradedConnection

                                            • denyOutboundUpgradedConnection(peerId, maConn): boolean | Promise<boolean>

                                            • denyOutboundUpgradedConnection tests whether a fully capable connection is allowed.

                                              This is called after encryption has been negotiated and the connection has been multiplexed, if a multiplexer is configured.

                                              Return true to deny the passed upgraded connection.

                                              -

                                              Parameters

                                              Returns boolean | Promise<boolean>

                                            Optional filterMultiaddrForPeer

                                            Optional filterMultiaddrForPeer

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            denyDialMultiaddrdenyDialPeerdenyInboundConnectiondenyInboundEncryptedConnectiondenyInboundRelayReservationdenyInboundRelayedConnectiondenyInboundUpgradedConnectiondenyOutboundConnectiondenyOutboundEncryptedConnectiondenyOutboundRelayedConnectiondenyOutboundUpgradedConnectionfilterMultiaddrForPeer
                                            \ No newline at end of file +

                                            Parameters

                                            Returns boolean | Promise<boolean>

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            denyDialMultiaddrdenyDialPeerdenyInboundConnectiondenyInboundEncryptedConnectiondenyInboundRelayReservationdenyInboundRelayedConnectiondenyInboundUpgradedConnectiondenyOutboundConnectiondenyOutboundEncryptedConnectiondenyOutboundRelayedConnectiondenyOutboundUpgradedConnectionfilterMultiaddrForPeer
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.ConnectionLimits.html b/interfaces/_libp2p_interface.ConnectionLimits.html index ce81c5b7c3..a655492a18 100644 --- a/interfaces/_libp2p_interface.ConnectionLimits.html +++ b/interfaces/_libp2p_interface.ConnectionLimits.html @@ -4,10 +4,10 @@

                                            These limits are applied by Circuit Relay v2 servers, for example and the connection will normally be closed abruptly if the limits are exceeded.

                                            -
                                            interface ConnectionLimits {
                                                bytes?: bigint;
                                                seconds?: number;
                                            }

                                            Properties

                                            bytes? +
                                            interface ConnectionLimits {
                                                bytes?: bigint;
                                                seconds?: number;
                                            }

                                            Properties

                                            bytes? seconds?

                                            Properties

                                            Optional bytes

                                            bytes?: bigint

                                            If present this is the number of bytes remaining that may be transferred over this connection

                                            -

                                            Optional seconds

                                            seconds?: number

                                            If present this is the number of seconds that this connection will +

                                            Optional seconds

                                            seconds?: number

                                            If present this is the number of seconds that this connection will remain open for

                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            bytesseconds
                                            \ No newline at end of file +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            bytesseconds
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.ConnectionProtector.html b/interfaces/_libp2p_interface.ConnectionProtector.html index 97d47de0fe..7c107e2cd3 100644 --- a/interfaces/_libp2p_interface.ConnectionProtector.html +++ b/interfaces/_libp2p_interface.ConnectionProtector.html @@ -1,5 +1,5 @@ -ConnectionProtector | libp2p

                                            Interface ConnectionProtector

                                            interface ConnectionProtector {
                                                protect(connection, options?): Promise<MultiaddrConnection>;
                                            }

                                            Methods

                                            protect +ConnectionProtector | libp2p

                                            Interface ConnectionProtector

                                            interface ConnectionProtector {
                                                protect(connection, options?): Promise<MultiaddrConnection>;
                                            }

                                            Methods

                                            protect

                                            Methods

                                            protect

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            protect
                                            \ No newline at end of file +

                                            Parameters

                                            Returns Promise<MultiaddrConnection>

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            protect
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.ConnectionTimeline.html b/interfaces/_libp2p_interface.ConnectionTimeline.html index 0789bc76e7..eb5b5d3730 100644 --- a/interfaces/_libp2p_interface.ConnectionTimeline.html +++ b/interfaces/_libp2p_interface.ConnectionTimeline.html @@ -1,8 +1,8 @@ -ConnectionTimeline | libp2p

                                            Interface ConnectionTimeline

                                            interface ConnectionTimeline {
                                                close?: number;
                                                open: number;
                                                upgraded?: number;
                                            }

                                            Properties

                                            close? +ConnectionTimeline | libp2p

                                            Interface ConnectionTimeline

                                            interface ConnectionTimeline {
                                                close?: number;
                                                open: number;
                                                upgraded?: number;
                                            }

                                            Properties

                                            close? open upgraded?

                                            Properties

                                            Optional close

                                            close?: number

                                            When the connection was closed.

                                            -

                                            open

                                            open: number

                                            When the connection was opened

                                            -

                                            Optional upgraded

                                            upgraded?: number

                                            When the MultiaddrConnection was upgraded to a Connection - e.g. the type +

                                            open

                                            open: number

                                            When the connection was opened

                                            +

                                            Optional upgraded

                                            upgraded?: number

                                            When the MultiaddrConnection was upgraded to a Connection - e.g. the type of connection encryption and multiplexing was negotiated.

                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            closeopenupgraded
                                            \ No newline at end of file +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            closeopenupgraded
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.ContentRouting.html b/interfaces/_libp2p_interface.ContentRouting.html index 92831588b5..82b0f8b54b 100644 --- a/interfaces/_libp2p_interface.ContentRouting.html +++ b/interfaces/_libp2p_interface.ContentRouting.html @@ -1,4 +1,4 @@ -ContentRouting | libp2p

                                            Interface ContentRouting

                                            interface ContentRouting {
                                                cancelReprovide(key, options?): Promise<void>;
                                                findProviders(cid, options?): AsyncIterable<PeerInfo>;
                                                get(key, options?): Promise<Uint8Array>;
                                                provide(cid, options?): Promise<void>;
                                                put(key, value, options?): Promise<void>;
                                            }

                                            Methods

                                            cancelReprovide +ContentRouting | libp2p

                                            Interface ContentRouting

                                            interface ContentRouting {
                                                cancelReprovide(key, options?): Promise<void>;
                                                findProviders(cid, options?): AsyncIterable<PeerInfo>;
                                                get(key, options?): Promise<Uint8Array>;
                                                provide(cid, options?): Promise<void>;
                                                put(key, value, options?): Promise<void>;
                                            }

                                            Methods

                                            cancelReprovide findProviders get provide @@ -6,18 +6,18 @@

                                            Methods

                                            cancelReprovide

                                            findProviders

                                            findProviders

                                            get

                                            get

                                            provide

                                            provide

                                            put

                                            put

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            cancelReprovidefindProvidersgetprovideput
                                            \ No newline at end of file +

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            cancelReprovidefindProvidersgetprovideput
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.ContentRoutingProvider.html b/interfaces/_libp2p_interface.ContentRoutingProvider.html index 76a61b9a2a..385e7bfca7 100644 --- a/interfaces/_libp2p_interface.ContentRoutingProvider.html +++ b/interfaces/_libp2p_interface.ContentRoutingProvider.html @@ -1,4 +1,4 @@ ContentRoutingProvider | libp2p

                                            Interface ContentRoutingProvider

                                            Implementers of this interface can provide a ContentRouting implementation to interested callers.

                                            -
                                            interface ContentRoutingProvider {
                                                [contentRoutingSymbol]: ContentRouting;
                                            }

                                            Properties

                                            [contentRoutingSymbol] -

                                            Properties

                                            [contentRoutingSymbol]

                                            [contentRoutingSymbol]: ContentRouting

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            [contentRoutingSymbol]
                                            \ No newline at end of file +
                                            interface ContentRoutingProvider {
                                                [contentRoutingSymbol]: ContentRouting;
                                            }

                                            Properties

                                            [contentRoutingSymbol] +

                                            Properties

                                            [contentRoutingSymbol]

                                            [contentRoutingSymbol]: ContentRouting

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            [contentRoutingSymbol]
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Counter.html b/interfaces/_libp2p_interface.Counter.html index cb128a41cf..ff6f31bd6a 100644 --- a/interfaces/_libp2p_interface.Counter.html +++ b/interfaces/_libp2p_interface.Counter.html @@ -1,7 +1,7 @@ Counter | libp2p

                                            Interface Counter

                                            A tracked counter loosely based on the Counter interface exposed by the prom-client module - counters are metrics that only go up

                                            -
                                            interface Counter {
                                                increment(value?): void;
                                                reset(): void;
                                            }

                                            Methods

                                            increment +
                                            interface Counter {
                                                increment(value?): void;
                                                reset(): void;
                                            }

                                            Methods

                                            increment reset

                                            Methods

                                            increment

                                            reset

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            incrementreset
                                            \ No newline at end of file +

                                            Parameters

                                            Returns void

                                            reset

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            incrementreset
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.CounterGroup.html b/interfaces/_libp2p_interface.CounterGroup.html index d4c190a9be..49f721d130 100644 --- a/interfaces/_libp2p_interface.CounterGroup.html +++ b/interfaces/_libp2p_interface.CounterGroup.html @@ -1,10 +1,10 @@ CounterGroup | libp2p

                                            Interface CounterGroup<T>

                                            A group of tracked counters loosely based on the Counter interface exposed by the prom-client module - counters are metrics that only go up

                                            -
                                            interface CounterGroup<T> {
                                                increment(values): void;
                                                reset(): void;
                                            }

                                            Type Parameters

                                            • T extends string = any

                                            Methods

                                            increment +
                                            interface CounterGroup<T> {
                                                increment(values): void;
                                                reset(): void;
                                            }

                                            Type Parameters

                                            • T extends string = any

                                            Methods

                                            increment reset

                                            Methods

                                            increment

                                            reset

                                            reset

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            incrementreset
                                            \ No newline at end of file +

                                            Returns void

                                            Settings

                                            Member Visibility

                                            Theme

                                            On This Page

                                            incrementreset
                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.CreateListenerOptions.html b/interfaces/_libp2p_interface.CreateListenerOptions.html index f5ce18d20c..728ca4a7f0 100644 --- a/interfaces/_libp2p_interface.CreateListenerOptions.html +++ b/interfaces/_libp2p_interface.CreateListenerOptions.html @@ -1,4 +1,4 @@ -CreateListenerOptions | libp2p

                                            Interface CreateListenerOptions

                                            interface CreateListenerOptions {
                                                upgrader: Upgrader;
                                            }

                                            Hierarchy

                                            • CreateListenerOptions

                                              Properties

                                              upgrader +CreateListenerOptions | libp2p

                                              Interface CreateListenerOptions

                                              interface CreateListenerOptions {
                                                  upgrader: Upgrader;
                                              }

                                              Hierarchy

                                              • CreateListenerOptions

                                                Properties

                                                upgrader

                                                Properties

                                                upgrader

                                                upgrader: Upgrader

                                                The upgrader turns a MultiaddrConnection into a Connection and notifies other libp2p components about a new incoming connection.

                                                -

                                                Settings

                                                Member Visibility

                                                Theme

                                                On This Page

                                                upgrader
                                                \ No newline at end of file +

                                                Settings

                                                Member Visibility

                                                Theme

                                                On This Page

                                                upgrader
                                                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.DialOptions.html b/interfaces/_libp2p_interface.DialOptions.html index 401c90eb4b..aef06a83c3 100644 --- a/interfaces/_libp2p_interface.DialOptions.html +++ b/interfaces/_libp2p_interface.DialOptions.html @@ -2,8 +2,8 @@ the optional signal property.

                                                Example

                                                const controller = new AbortController()

                                                aLongRunningOperation({
                                                  signal: controller.signal
                                                })

                                                // later

                                                controller.abort()
                                                -
                                                interface DialOptions {
                                                    force?: boolean;
                                                    onProgress?: ((evt) => void);
                                                    signal?: AbortSignal;
                                                }

                                                Hierarchy (view full)

                                                Properties

                                                force? +
                                                interface DialOptions {
                                                    force?: boolean;
                                                    onProgress?: ((evt) => void);
                                                    signal?: AbortSignal;
                                                }

                                                Hierarchy (view full)

                                                Properties

                                                force? onProgress? signal?

                                                Properties

                                                Optional force

                                                force?: boolean

                                                If true, open a new connection to the remote even if one already exists

                                                -

                                                Optional onProgress

                                                onProgress?: ((evt) => void)

                                                Type declaration

                                                  • (evt): void

                                                  • Parameters

                                                    • evt: any

                                                    Returns void

                                                Optional signal

                                                signal?: AbortSignal

                                                Settings

                                                Member Visibility

                                                Theme

                                                On This Page

                                                forceonProgresssignal
                                                \ No newline at end of file +

                                                Optional onProgress

                                                onProgress?: ((evt) => void)

                                                Type declaration

                                                  • (evt): void

                                                  • Parameters

                                                    • evt: any

                                                    Returns void

                                                Optional signal

                                                signal?: AbortSignal

                                                Settings

                                                Member Visibility

                                                Theme

                                                On This Page

                                                forceonProgresssignal
                                                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.DialProtocolOptions.html b/interfaces/_libp2p_interface.DialProtocolOptions.html index b7c9aee1f3..5aa2fca2b6 100644 --- a/interfaces/_libp2p_interface.DialProtocolOptions.html +++ b/interfaces/_libp2p_interface.DialProtocolOptions.html @@ -2,14 +2,14 @@ the optional signal property.

                                                Example

                                                const controller = new AbortController()

                                                aLongRunningOperation({
                                                  signal: controller.signal
                                                })

                                                // later

                                                controller.abort()
                                                -
                                                interface DialProtocolOptions {
                                                    maxOutboundStreams?: number;
                                                    negotiateFully?: boolean;
                                                    runOnLimitedConnection?: boolean;
                                                    signal?: AbortSignal;
                                                }

                                                Hierarchy (view full)

                                                Properties

                                                maxOutboundStreams? +
                                                interface DialProtocolOptions {
                                                    maxOutboundStreams?: number;
                                                    negotiateFully?: boolean;
                                                    runOnLimitedConnection?: boolean;
                                                    signal?: AbortSignal;
                                                }

                                                Hierarchy (view full)

                                                Properties

                                                maxOutboundStreams? negotiateFully? runOnLimitedConnection? signal?

                                                Properties

                                                Optional maxOutboundStreams

                                                maxOutboundStreams?: number

                                                If specified, and no handler has been registered with the registrar for the successfully negotiated protocol, use this as the max outbound stream limit for the protocol

                                                -

                                                Optional negotiateFully

                                                negotiateFully?: boolean

                                                By default when negotiating a protocol the dialer writes then protocol name +

                                                Optional negotiateFully

                                                negotiateFully?: boolean

                                                By default when negotiating a protocol the dialer writes then protocol name then reads the response.

                                                When a only a single protocol is being negotiated on an outbound stream, and the stream is written to before being read from, we can optimistically @@ -27,11 +27,11 @@ in full before the stream is returned so this option has no effect.

                                                Default

                                                true
                                                -

                                                Optional runOnLimitedConnection

                                                runOnLimitedConnection?: boolean

                                                Opt-in to running over a limited connection - one that has restrictions +

                                                Optional runOnLimitedConnection

                                                runOnLimitedConnection?: boolean

                                                Opt-in to running over a limited connection - one that has restrictions on the amount of data that may be transferred or how long it may be open for.

                                                These limits are typically enforced by a relay server, if the protocol will be transferring a lot of data or the stream will be open for a long time consider upgrading to a direct connection before opening the stream.

                                                Default

                                                false
                                                -

                                                Optional signal

                                                signal?: AbortSignal

                                                Settings

                                                Member Visibility

                                                Theme

                                                On This Page

                                                maxOutboundStreamsnegotiateFullyrunOnLimitedConnectionsignal
                                                \ No newline at end of file +

                                                Optional signal

                                                signal?: AbortSignal

                                                Settings

                                                Member Visibility

                                                Theme

                                                On This Page

                                                maxOutboundStreamsnegotiateFullyrunOnLimitedConnectionsignal
                                                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.DialTransportOptions.html b/interfaces/_libp2p_interface.DialTransportOptions.html index 4b70df3671..af2c47fc94 100644 --- a/interfaces/_libp2p_interface.DialTransportOptions.html +++ b/interfaces/_libp2p_interface.DialTransportOptions.html @@ -2,9 +2,9 @@ the optional signal property.

                                                Example

                                                const controller = new AbortController()

                                                aLongRunningOperation({
                                                  signal: controller.signal
                                                })

                                                // later

                                                controller.abort()
                                                -
                                                interface DialTransportOptions<DialEvents> {
                                                    onProgress?: ((evt) => void);
                                                    signal?: AbortSignal;
                                                    upgrader: Upgrader;
                                                }

                                                Type Parameters

                                                Hierarchy (view full)

                                                Properties

                                                onProgress? +
                                                interface DialTransportOptions<DialEvents> {
                                                    onProgress?: ((evt) => void);
                                                    signal?: AbortSignal;
                                                    upgrader: Upgrader;
                                                }

                                                Type Parameters

                                                Hierarchy (view full)

                                                Properties

                                                onProgress? signal? upgrader -

                                                Properties

                                                Optional onProgress

                                                onProgress?: ((evt) => void)

                                                Type declaration

                                                Optional signal

                                                signal?: AbortSignal

                                                upgrader

                                                upgrader: Upgrader

                                                The upgrader turns a MultiaddrConnection into a Connection which should be +

                                                Properties

                                                Optional onProgress

                                                onProgress?: ((evt) => void)

                                                Type declaration

                                                Optional signal

                                                signal?: AbortSignal

                                                upgrader

                                                upgrader: Upgrader

                                                The upgrader turns a MultiaddrConnection into a Connection which should be returned by the transport's dial method

                                                -

                                                Settings

                                                Member Visibility

                                                Theme

                                                On This Page

                                                onProgresssignalupgrader
                                                \ No newline at end of file +

                                                Settings

                                                Member Visibility

                                                Theme

                                                On This Page

                                                onProgresssignalupgrader
                                                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Ed25519PeerId.html b/interfaces/_libp2p_interface.Ed25519PeerId.html index 6d5beb54c3..cf502cc473 100644 --- a/interfaces/_libp2p_interface.Ed25519PeerId.html +++ b/interfaces/_libp2p_interface.Ed25519PeerId.html @@ -1,4 +1,4 @@ -Ed25519PeerId | libp2p

                                                Interface Ed25519PeerId

                                                interface Ed25519PeerId {
                                                    publicKey: Ed25519PublicKey;
                                                    type: "Ed25519";
                                                    equals(other?): boolean;
                                                    toCID(): CID<Uint8Array, 114, 0, 1>;
                                                    toMultihash(): MultihashDigest<0>;
                                                    toString(): string;
                                                }

                                                Properties

                                                publicKey +Ed25519PeerId | libp2p

                                                Interface Ed25519PeerId

                                                interface Ed25519PeerId {
                                                    publicKey: Ed25519PublicKey;
                                                    type: "Ed25519";
                                                    equals(other?): boolean;
                                                    toCID(): CID<Uint8Array, 114, 0, 1>;
                                                    toMultihash(): MultihashDigest<0>;
                                                    toString(): string;
                                                }

                                                Properties

                                                publicKey type

                                                Methods

                                                equals toCID @@ -6,10 +6,10 @@ toString

                                                Properties

                                                Readonly publicKey

                                                publicKey: Ed25519PublicKey

                                                This will always be defined as the public key is embedded in the multihash of this PeerId

                                                -

                                                Readonly type

                                                type: "Ed25519"

                                                Methods

                                                equals

                                                toCID

                                                Readonly type

                                                type: "Ed25519"

                                                Methods

                                                equals

                                                toCID

                                                toMultihash

                                                toMultihash

                                                toString

                                                Settings

                                                Member Visibility

                                                Theme

                                                On This Page

                                                publicKeytypeequalstoCIDtoMultihashtoString
                                                \ No newline at end of file +

                                                Returns MultihashDigest<0>

                                                toString

                                                Settings

                                                Member Visibility

                                                Theme

                                                On This Page

                                                publicKeytypeequalstoCIDtoMultihashtoString
                                                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Ed25519PrivateKey.html b/interfaces/_libp2p_interface.Ed25519PrivateKey.html index b3ec5b5172..5412ee1c38 100644 --- a/interfaces/_libp2p_interface.Ed25519PrivateKey.html +++ b/interfaces/_libp2p_interface.Ed25519PrivateKey.html @@ -1,12 +1,12 @@ -Ed25519PrivateKey | libp2p

                                                Interface Ed25519PrivateKey

                                                interface Ed25519PrivateKey {
                                                    publicKey: Ed25519PublicKey;
                                                    raw: Uint8Array;
                                                    type: "Ed25519";
                                                    equals(key?): boolean;
                                                    sign(data): Uint8Array | Promise<Uint8Array>;
                                                }

                                                Properties

                                                publicKey +Ed25519PrivateKey | libp2p

                                                Interface Ed25519PrivateKey

                                                interface Ed25519PrivateKey {
                                                    publicKey: Ed25519PublicKey;
                                                    raw: Uint8Array;
                                                    type: "Ed25519";
                                                    equals(key?): boolean;
                                                    sign(data): Uint8Array | Promise<Uint8Array>;
                                                }

                                                Properties

                                                publicKey raw type

                                                Methods

                                                equals sign

                                                Properties

                                                Readonly publicKey

                                                publicKey: Ed25519PublicKey

                                                The public key that corresponds to this private key

                                                -

                                                Readonly raw

                                                raw: Uint8Array

                                                The raw public key bytes

                                                -

                                                Readonly type

                                                type: "Ed25519"

                                                The type of this key

                                                -

                                                Methods

                                                equals

                                                sign

                                                Readonly raw

                                                raw: Uint8Array

                                                The raw public key bytes

                                                +

                                                Readonly type

                                                type: "Ed25519"

                                                The type of this key

                                                +

                                                Methods

                                                equals

                                                sign

                                                Settings

                                                Member Visibility

                                                Theme

                                                On This Page

                                                publicKeyrawtypeequalssign
                                                \ No newline at end of file +

                                                Parameters

                                                Returns Uint8Array | Promise<Uint8Array>

                                                Settings

                                                Member Visibility

                                                Theme

                                                On This Page

                                                publicKeyrawtypeequalssign
                                                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Ed25519PublicKey.html b/interfaces/_libp2p_interface.Ed25519PublicKey.html index 771be1c31a..f02b6ea493 100644 --- a/interfaces/_libp2p_interface.Ed25519PublicKey.html +++ b/interfaces/_libp2p_interface.Ed25519PublicKey.html @@ -1,4 +1,4 @@ -Ed25519PublicKey | libp2p

                                                Interface Ed25519PublicKey

                                                interface Ed25519PublicKey {
                                                    raw: Uint8Array;
                                                    type: "Ed25519";
                                                    equals(key?): boolean;
                                                    toCID(): CID<unknown, 114, 0, 1>;
                                                    toMultihash(): MultihashDigest<0>;
                                                    toString(): string;
                                                    verify(data, sig): boolean | Promise<boolean>;
                                                }

                                                Properties

                                                raw +Ed25519PublicKey | libp2p

                                                Interface Ed25519PublicKey

                                                interface Ed25519PublicKey {
                                                    raw: Uint8Array;
                                                    type: "Ed25519";
                                                    equals(key?): boolean;
                                                    toCID(): CID<unknown, 114, 0, 1>;
                                                    toMultihash(): MultihashDigest<0>;
                                                    toString(): string;
                                                    verify(data, sig): boolean | Promise<boolean>;
                                                }

                                                Properties

                                                raw type

                                                Methods

                                                equals toCID @@ -6,14 +6,14 @@ toString verify

                                                Properties

                                                Readonly raw

                                                raw: Uint8Array

                                                The raw public key bytes

                                                -

                                                Readonly type

                                                type: "Ed25519"

                                                The type of this key

                                                -

                                                Methods

                                                equals

                                                toCID

                                                Readonly type

                                                type: "Ed25519"

                                                The type of this key

                                                +

                                                Methods

                                                equals

                                                toCID

                                                • toCID(): CID<unknown, 114, 0, 1>

                                                • Return this public key as a CID encoded with the libp2p-key codec

                                                  The digest contains an identity hash containing the protobuf wrapped version of the public key.

                                                  -

                                                  Returns CID<unknown, 114, 0, 1>

                                                toMultihash

                                                toMultihash

                                                toString

                                                verify

                                                toString

                                                verify

                                                Settings

                                                Member Visibility

                                                Theme

                                                On This Page

                                                rawtypeequalstoCIDtoMultihashtoStringverify
                                                \ No newline at end of file +

                                                Parameters

                                                Returns boolean | Promise<boolean>

                                                Settings

                                                Member Visibility

                                                Theme

                                                On This Page

                                                rawtypeequalstoCIDtoMultihashtoStringverify
                                                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Envelope.html b/interfaces/_libp2p_interface.Envelope.html index 9402eb35b6..da74ffe13b 100644 --- a/interfaces/_libp2p_interface.Envelope.html +++ b/interfaces/_libp2p_interface.Envelope.html @@ -1,8 +1,8 @@ -Envelope | libp2p

                                                Interface Envelope

                                                interface Envelope {
                                                    payload: Uint8Array;
                                                    payloadType: Uint8Array | Uint8ArrayList;
                                                    publicKey: PublicKey;
                                                    signature: Uint8Array | Uint8ArrayList;
                                                    equals(other): boolean;
                                                    marshal(): Uint8Array;
                                                    validate(domain): Promise<boolean>;
                                                }

                                                Implemented by

                                                  Properties

                                                  payload +Envelope | libp2p

                                                  Interface Envelope

                                                  interface Envelope {
                                                      payload: Uint8Array;
                                                      payloadType: Uint8Array | Uint8ArrayList;
                                                      publicKey: PublicKey;
                                                      signature: Uint8Array | Uint8ArrayList;
                                                      equals(other): boolean;
                                                      marshal(): Uint8Array;
                                                      validate(domain): Promise<boolean>;
                                                  }

                                                  Implemented by

                                                    Properties

                                                    payload payloadType publicKey signature

                                                    Methods

                                                    equals marshal validate -

                                                    Properties

                                                    payload

                                                    payload: Uint8Array

                                                    payloadType

                                                    payloadType: Uint8Array | Uint8ArrayList

                                                    publicKey

                                                    publicKey: PublicKey

                                                    signature

                                                    signature: Uint8Array | Uint8ArrayList

                                                    Methods

                                                    equals

                                                    marshal

                                                    validate

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    payloadpayloadTypepublicKeysignatureequalsmarshalvalidate
                                                    \ No newline at end of file +

                                                    Properties

                                                    payload

                                                    payload: Uint8Array

                                                    payloadType

                                                    payloadType: Uint8Array | Uint8ArrayList

                                                    publicKey

                                                    publicKey: PublicKey

                                                    signature

                                                    signature: Uint8Array | Uint8ArrayList

                                                    Methods

                                                    equals

                                                    marshal

                                                    validate

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    payloadpayloadTypepublicKeysignatureequalsmarshalvalidate
                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.EventCallback.html b/interfaces/_libp2p_interface.EventCallback.html index a1e1c7a660..5a6ff921bf 100644 --- a/interfaces/_libp2p_interface.EventCallback.html +++ b/interfaces/_libp2p_interface.EventCallback.html @@ -1 +1 @@ -EventCallback | libp2p

                                                    Interface EventCallback<EventType>

                                                    interface EventCallback<EventType> ((evt) => void)

                                                    Type Parameters

                                                    • EventType

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    \ No newline at end of file +EventCallback | libp2p

                                                    Interface EventCallback<EventType>

                                                    interface EventCallback<EventType> ((evt) => void)

                                                    Type Parameters

                                                    • EventType

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.EventObject.html b/interfaces/_libp2p_interface.EventObject.html index adf457e448..30f8cf6395 100644 --- a/interfaces/_libp2p_interface.EventObject.html +++ b/interfaces/_libp2p_interface.EventObject.html @@ -1,2 +1,2 @@ -EventObject | libp2p

                                                    Interface EventObject<EventType>

                                                    interface EventObject<EventType> {
                                                        handleEvent: EventCallback<EventType>;
                                                    }

                                                    Type Parameters

                                                    • EventType

                                                    Properties

                                                    handleEvent -

                                                    Properties

                                                    handleEvent

                                                    handleEvent: EventCallback<EventType>

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    handleEvent
                                                    \ No newline at end of file +EventObject | libp2p

                                                    Interface EventObject<EventType>

                                                    interface EventObject<EventType> {
                                                        handleEvent: EventCallback<EventType>;
                                                    }

                                                    Type Parameters

                                                    • EventType

                                                    Properties

                                                    handleEvent +

                                                    Properties

                                                    handleEvent

                                                    handleEvent: EventCallback<EventType>

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    handleEvent
                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Histogram.html b/interfaces/_libp2p_interface.Histogram.html index 3a272e6f52..f3ff8a6720 100644 --- a/interfaces/_libp2p_interface.Histogram.html +++ b/interfaces/_libp2p_interface.Histogram.html @@ -1,8 +1,8 @@ -Histogram | libp2p

                                                    Interface Histogram

                                                    interface Histogram {
                                                        observe(value): void;
                                                        reset(): void;
                                                        timer(): StopTimer;
                                                    }

                                                    Methods

                                                    observe +Histogram | libp2p

                                                    Interface Histogram

                                                    interface Histogram {
                                                        observe(value): void;
                                                        reset(): void;
                                                        timer(): StopTimer;
                                                    }

                                                    Methods

                                                    observe reset timer

                                                    Methods

                                                    observe

                                                    reset

                                                    timer

                                                    reset

                                                    timer

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    observeresettimer
                                                    \ No newline at end of file +

                                                    Returns StopTimer

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    observeresettimer
                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.HistogramGroup.html b/interfaces/_libp2p_interface.HistogramGroup.html index bdc31f67ba..32a2b912b1 100644 --- a/interfaces/_libp2p_interface.HistogramGroup.html +++ b/interfaces/_libp2p_interface.HistogramGroup.html @@ -1,9 +1,9 @@ -HistogramGroup | libp2p

                                                    Interface HistogramGroup<T>

                                                    interface HistogramGroup<T> {
                                                        observe(values): void;
                                                        reset(): void;
                                                        timer(key): StopTimer;
                                                    }

                                                    Type Parameters

                                                    • T extends string = any

                                                    Methods

                                                    observe +HistogramGroup | libp2p

                                                    Interface HistogramGroup<T>

                                                    interface HistogramGroup<T> {
                                                        observe(values): void;
                                                        reset(): void;
                                                        timer(key): StopTimer;
                                                    }

                                                    Type Parameters

                                                    • T extends string = any

                                                    Methods

                                                    observe reset timer

                                                    Methods

                                                    observe

                                                    reset

                                                    reset

                                                    timer

                                                    timer

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    observeresettimer
                                                    \ No newline at end of file +

                                                    Parameters

                                                    • key: string

                                                    Returns StopTimer

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    observeresettimer
                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.HistogramOptions.html b/interfaces/_libp2p_interface.HistogramOptions.html index 6d9bec9c8d..c406a40dab 100644 --- a/interfaces/_libp2p_interface.HistogramOptions.html +++ b/interfaces/_libp2p_interface.HistogramOptions.html @@ -1,9 +1,9 @@ HistogramOptions | libp2p

                                                    Interface HistogramOptions

                                                    Create tracked metrics with these options. Loosely based on the interfaces exposed by the prom-client module

                                                    -
                                                    interface HistogramOptions {
                                                        buckets?: number[];
                                                        help?: string;
                                                        label?: string;
                                                    }

                                                    Hierarchy (view full)

                                                    Properties

                                                    buckets? +
                                                    interface HistogramOptions {
                                                        buckets?: number[];
                                                        help?: string;
                                                        label?: string;
                                                    }

                                                    Hierarchy (view full)

                                                    Properties

                                                    buckets? help? label?

                                                    Properties

                                                    Optional buckets

                                                    buckets?: number[]

                                                    Buckets for the histogram

                                                    -

                                                    Optional help

                                                    help?: string

                                                    Optional help for the metric

                                                    -

                                                    Optional label

                                                    label?: string

                                                    Optional label for the metric

                                                    -

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    bucketshelplabel
                                                    \ No newline at end of file +

                                                    Optional help

                                                    help?: string

                                                    Optional help for the metric

                                                    +

                                                    Optional label

                                                    label?: string

                                                    Optional label for the metric

                                                    +

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    bucketshelplabel
                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.IdentifyResult.html b/interfaces/_libp2p_interface.IdentifyResult.html index 4197e70eb1..c173c6231a 100644 --- a/interfaces/_libp2p_interface.IdentifyResult.html +++ b/interfaces/_libp2p_interface.IdentifyResult.html @@ -1,5 +1,5 @@ IdentifyResult | libp2p

                                                    Interface IdentifyResult

                                                    Data returned from a successful identify response

                                                    -
                                                    interface IdentifyResult {
                                                        agentVersion?: string;
                                                        connection: Connection;
                                                        listenAddrs: Multiaddr[];
                                                        observedAddr?: Multiaddr;
                                                        peerId: PeerId;
                                                        protocolVersion?: string;
                                                        protocols: string[];
                                                        publicKey?: Uint8Array;
                                                        signedPeerRecord?: SignedPeerRecord;
                                                    }

                                                    Properties

                                                    agentVersion? +
                                                    interface IdentifyResult {
                                                        agentVersion?: string;
                                                        connection: Connection;
                                                        listenAddrs: Multiaddr[];
                                                        observedAddr?: Multiaddr;
                                                        peerId: PeerId;
                                                        protocolVersion?: string;
                                                        protocols: string[];
                                                        publicKey?: Uint8Array;
                                                        signedPeerRecord?: SignedPeerRecord;
                                                    }

                                                    Properties

                                                    agentVersion? connection listenAddrs observedAddr? @@ -9,16 +9,16 @@ publicKey? signedPeerRecord?

                                                    Properties

                                                    Optional agentVersion

                                                    agentVersion?: string

                                                    The remote agent version

                                                    -

                                                    connection

                                                    connection: Connection

                                                    The connection that the identify protocol ran over

                                                    -

                                                    listenAddrs

                                                    listenAddrs: Multiaddr[]

                                                    The unsigned addresses they are listening on. Note - any multiaddrs present +

                                                    connection

                                                    connection: Connection

                                                    The connection that the identify protocol ran over

                                                    +

                                                    listenAddrs

                                                    listenAddrs: Multiaddr[]

                                                    The unsigned addresses they are listening on. Note - any multiaddrs present in the signed peer record should be preferred to the value here.

                                                    -

                                                    Optional observedAddr

                                                    observedAddr?: Multiaddr

                                                    If set this is the address that the remote peer saw the identify request +

                                                    Optional observedAddr

                                                    observedAddr?: Multiaddr

                                                    If set this is the address that the remote peer saw the identify request originate from

                                                    -

                                                    peerId

                                                    peerId: PeerId

                                                    The remote Peer's PeerId

                                                    -

                                                    Optional protocolVersion

                                                    protocolVersion?: string

                                                    The remote protocol version

                                                    -

                                                    protocols

                                                    protocols: string[]

                                                    The protocols the remote peer supports

                                                    -

                                                    Optional publicKey

                                                    publicKey?: Uint8Array

                                                    The public key part of the remote PeerId - this is only useful for older +

                                                    peerId

                                                    peerId: PeerId

                                                    The remote Peer's PeerId

                                                    +

                                                    Optional protocolVersion

                                                    protocolVersion?: string

                                                    The remote protocol version

                                                    +

                                                    protocols

                                                    protocols: string[]

                                                    The protocols the remote peer supports

                                                    +

                                                    Optional publicKey

                                                    publicKey?: Uint8Array

                                                    The public key part of the remote PeerId - this is only useful for older RSA-based PeerIds, the more modern Ed25519 and secp256k1 types have the public key embedded in them

                                                    -

                                                    Optional signedPeerRecord

                                                    signedPeerRecord?: SignedPeerRecord

                                                    If sent by the remote peer this is the deserialized signed peer record

                                                    -

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    agentVersionconnectionlistenAddrsobservedAddrpeerIdprotocolVersionprotocolspublicKeysignedPeerRecord
                                                    \ No newline at end of file +

                                                    Optional signedPeerRecord

                                                    signedPeerRecord?: SignedPeerRecord

                                                    If sent by the remote peer this is the deserialized signed peer record

                                                    +

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    agentVersionconnectionlistenAddrsobservedAddrpeerIdprotocolVersionprotocolspublicKeysignedPeerRecord
                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.IncomingStreamData.html b/interfaces/_libp2p_interface.IncomingStreamData.html index 0aaeefe244..b3333f715e 100644 --- a/interfaces/_libp2p_interface.IncomingStreamData.html +++ b/interfaces/_libp2p_interface.IncomingStreamData.html @@ -1,3 +1,3 @@ -IncomingStreamData | libp2p

                                                    Interface IncomingStreamData

                                                    interface IncomingStreamData {
                                                        connection: Connection;
                                                        stream: Stream;
                                                    }

                                                    Properties

                                                    connection +IncomingStreamData | libp2p

                                                    Interface IncomingStreamData

                                                    interface IncomingStreamData {
                                                        connection: Connection;
                                                        stream: Stream;
                                                    }

                                                    Properties

                                                    connection stream -

                                                    Properties

                                                    connection

                                                    connection: Connection

                                                    stream

                                                    stream: Stream

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    connectionstream
                                                    \ No newline at end of file +

                                                    Properties

                                                    connection

                                                    connection: Connection

                                                    stream

                                                    stream: Stream

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    connectionstream
                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.IsDialableOptions.html b/interfaces/_libp2p_interface.IsDialableOptions.html index 843339cd01..30b3433e94 100644 --- a/interfaces/_libp2p_interface.IsDialableOptions.html +++ b/interfaces/_libp2p_interface.IsDialableOptions.html @@ -2,10 +2,10 @@ the optional signal property.

                                                    Example

                                                    const controller = new AbortController()

                                                    aLongRunningOperation({
                                                      signal: controller.signal
                                                    })

                                                    // later

                                                    controller.abort()
                                                    -
                                                    interface IsDialableOptions {
                                                        runOnLimitedConnection?: boolean;
                                                        signal?: AbortSignal;
                                                    }

                                                    Hierarchy (view full)

                                                    Properties

                                                    runOnLimitedConnection? +
                                                    interface IsDialableOptions {
                                                        runOnLimitedConnection?: boolean;
                                                        signal?: AbortSignal;
                                                    }

                                                    Hierarchy (view full)

                                                    Properties

                                                    runOnLimitedConnection? signal?

                                                    Properties

                                                    Optional runOnLimitedConnection

                                                    runOnLimitedConnection?: boolean

                                                    If the dial attempt would open a protocol, and the multiaddr being dialed is a circuit relay address, passing true here would cause the test to fail because that protocol would not be allowed to run over a data/time limited connection.

                                                    -

                                                    Optional signal

                                                    signal?: AbortSignal

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    runOnLimitedConnectionsignal
                                                    \ No newline at end of file +

                                                    Optional signal

                                                    signal?: AbortSignal

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    runOnLimitedConnectionsignal
                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Libp2p.html b/interfaces/_libp2p_interface.Libp2p.html index 44aa819ddb..1763a7317a 100644 --- a/interfaces/_libp2p_interface.Libp2p.html +++ b/interfaces/_libp2p_interface.Libp2p.html @@ -1,5 +1,5 @@ Libp2p | libp2p

                                                    Interface Libp2p<T>

                                                    Libp2p nodes implement this interface.

                                                    -
                                                    interface Libp2p<T> {
                                                        contentRouting: ContentRouting;
                                                        logger: ComponentLogger;
                                                        metrics?: Metrics;
                                                        peerId: PeerId;
                                                        peerRouting: PeerRouting;
                                                        peerStore: PeerStore;
                                                        services: T;
                                                        status: Libp2pStatus;
                                                        addEventListener<K>(type, listener, options?): void;
                                                        afterStart?(): void | Promise<void>;
                                                        afterStop?(): void | Promise<void>;
                                                        beforeStart?(): void | Promise<void>;
                                                        beforeStop?(): void | Promise<void>;
                                                        dial(peer, options?): Promise<Connection>;
                                                        dialProtocol(peer, protocols, options?): Promise<Stream>;
                                                        dispatchEvent(event): boolean;
                                                        dispatchEvent(event): boolean;
                                                        getConnections(peerId?): Connection[];
                                                        getDialQueue(): PendingDial[];
                                                        getMultiaddrs(): Multiaddr[];
                                                        getPeers(): PeerId[];
                                                        getProtocols(): string[];
                                                        getPublicKey(peer, options?): Promise<Ed25519PublicKey>;
                                                        getPublicKey(peer, options?): Promise<Secp256k1PublicKey>;
                                                        getPublicKey(peer, options?): Promise<RSAPublicKey>;
                                                        getPublicKey(peer, options?): Promise<never>;
                                                        getPublicKey(peer, options?): Promise<PublicKey>;
                                                        handle(protocol, handler, options?): Promise<void>;
                                                        hangUp(peer, options?): Promise<void>;
                                                        isDialable(multiaddr, options?): Promise<boolean>;
                                                        listenerCount(type): number;
                                                        register(protocol, topology): Promise<string>;
                                                        removeEventListener<K>(type, listener?, options?): void;
                                                        removeEventListener(type, listener?, options?): void;
                                                        safeDispatchEvent<Detail>(type, detail): boolean;
                                                        start(): void | Promise<void>;
                                                        stop(): void | Promise<void>;
                                                        unhandle(protocols): Promise<void>;
                                                        unregister(id): void;
                                                    }

                                                    Type Parameters

                                                    Hierarchy (view full)

                                                    Properties

                                                    contentRouting +
                                                    interface Libp2p<T> {
                                                        contentRouting: ContentRouting;
                                                        logger: ComponentLogger;
                                                        metrics?: Metrics;
                                                        peerId: PeerId;
                                                        peerRouting: PeerRouting;
                                                        peerStore: PeerStore;
                                                        services: T;
                                                        status: Libp2pStatus;
                                                        addEventListener<K>(type, listener, options?): void;
                                                        afterStart?(): void | Promise<void>;
                                                        afterStop?(): void | Promise<void>;
                                                        beforeStart?(): void | Promise<void>;
                                                        beforeStop?(): void | Promise<void>;
                                                        dial(peer, options?): Promise<Connection>;
                                                        dialProtocol(peer, protocols, options?): Promise<Stream>;
                                                        dispatchEvent(event): boolean;
                                                        dispatchEvent(event): boolean;
                                                        getConnections(peerId?): Connection[];
                                                        getDialQueue(): PendingDial[];
                                                        getMultiaddrs(): Multiaddr[];
                                                        getPeers(): PeerId[];
                                                        getProtocols(): string[];
                                                        getPublicKey(peer, options?): Promise<Ed25519PublicKey>;
                                                        getPublicKey(peer, options?): Promise<Secp256k1PublicKey>;
                                                        getPublicKey(peer, options?): Promise<RSAPublicKey>;
                                                        getPublicKey(peer, options?): Promise<never>;
                                                        getPublicKey(peer, options?): Promise<PublicKey>;
                                                        handle(protocol, handler, options?): Promise<void>;
                                                        hangUp(peer, options?): Promise<void>;
                                                        isDialable(multiaddr, options?): Promise<boolean>;
                                                        listenerCount(type): number;
                                                        register(protocol, topology): Promise<string>;
                                                        removeEventListener<K>(type, listener?, options?): void;
                                                        removeEventListener(type, listener?, options?): void;
                                                        safeDispatchEvent<Detail>(type, detail): boolean;
                                                        start(): void | Promise<void>;
                                                        stop(): void | Promise<void>;
                                                        unhandle(protocols): Promise<void>;
                                                        unregister(id): void;
                                                    }

                                                    Type Parameters

                                                    Hierarchy (view full)

                                                    Properties

                                                    contentRouting logger metrics? peerId @@ -37,49 +37,49 @@ the DHT.

                                                    Example

                                                    for await (const peerInfo of libp2p.contentRouting.findProviders(cid)) {
                                                      console.info(peerInfo)
                                                      // { id: PeerId(12D3Foo...), multiaddrs: [] ... }
                                                    }
                                                    -

                                                    logger

                                                    logger: ComponentLogger

                                                    The logger used by this libp2p node

                                                    -

                                                    Optional metrics

                                                    metrics?: Metrics

                                                    The metrics subsystem allows recording values to assess the health/performance +

                                                    logger

                                                    logger: ComponentLogger

                                                    The logger used by this libp2p node

                                                    +

                                                    Optional metrics

                                                    metrics?: Metrics

                                                    The metrics subsystem allows recording values to assess the health/performance of the running node.

                                                    Example

                                                    const metric = libp2p.metrics.registerMetric({
                                                      'my-metric'
                                                    })

                                                    // later
                                                    metric.update(5)
                                                    -

                                                    peerId

                                                    peerId: PeerId

                                                    The PeerId is a unique identifier for a node on the network.

                                                    +

                                                    peerId

                                                    peerId: PeerId

                                                    The PeerId is a unique identifier for a node on the network.

                                                    It is the hash of an RSA public key or, for Ed25519 or secp256k1 keys, the key itself.

                                                    Example

                                                    console.info(libp2p.peerId)
                                                    // PeerId(12D3Foo...)
                                                    -

                                                    peerRouting

                                                    peerRouting: PeerRouting

                                                    The peer routing subsystem allows the user to find peers on the network +

                                                    peerRouting

                                                    peerRouting: PeerRouting

                                                    The peer routing subsystem allows the user to find peers on the network or to find peers close to binary keys.

                                                    Example

                                                    const peerInfo = await libp2p.peerRouting.findPeer(peerId)
                                                    console.info(peerInfo)
                                                    // { id: PeerId(12D3Foo...), multiaddrs: [] ... }

                                                    Example

                                                    for await (const peerInfo of libp2p.peerRouting.getClosestPeers(key)) {
                                                      console.info(peerInfo)
                                                      // { id: PeerId(12D3Foo...), multiaddrs: [] ... }
                                                    }
                                                    -

                                                    peerStore

                                                    peerStore: PeerStore

                                                    The peer store holds information we know about other peers on the network.

                                                    +

                                                    peerStore

                                                    peerStore: PeerStore

                                                    The peer store holds information we know about other peers on the network.

                                                    • multiaddrs, supported protocols, etc.

                                                    Example

                                                    const peer = await libp2p.peerStore.get(peerId)
                                                    console.info(peer)
                                                    // { id: PeerId(12D3Foo...), addresses: [] ... }
                                                    -

                                                    services

                                                    services: T

                                                    A set of user defined services

                                                    -

                                                    status

                                                    status: Libp2pStatus

                                                    The current status of the libp2p node

                                                    -

                                                    Methods

                                                    addEventListener

                                                    Optional afterStart

                                                    services

                                                    services: T

                                                    A set of user defined services

                                                    +

                                                    status

                                                    status: Libp2pStatus

                                                    The current status of the libp2p node

                                                    +

                                                    Methods

                                                    addEventListener

                                                    Optional afterStart

                                                    Optional afterStop

                                                    Optional afterStop

                                                    Optional beforeStart

                                                    Optional beforeStart

                                                    Optional beforeStop

                                                    Optional beforeStop

                                                    dial

                                                    dial

                                                    • dial(peer, options?): Promise<Connection>

                                                    • Dials to the provided peer. If successful, the known metadata of the peer will be added to the nodes peerStore.

                                                      If a PeerId is passed as the first argument, the peer will need to have known multiaddrs for it in the PeerStore.

                                                      Parameters

                                                      Returns Promise<Connection>

                                                      Example

                                                      const conn = await libp2p.dial(remotePeerId)

                                                      // create a new stream within the connection
                                                      const stream = await conn.newStream(['/echo/1.1.0', '/echo/1.0.0'])

                                                      // protocol negotiated: 'echo/1.0.0' means that the other party only supports the older version

                                                      // ...
                                                      await conn.close()
                                                      -

                                                    dialProtocol

                                                    dialProtocol

                                                    • dialProtocol(peer, protocols, options?): Promise<Stream>

                                                    • Dials to the provided peer and tries to handshake with the given protocols in order. If successful, the known metadata of the peer will be added to the nodes peerStore, and the MuxedStream will be returned together with the successful negotiated protocol.

                                                      Parameters

                                                      Returns Promise<Stream>

                                                      Example

                                                      import { pipe } from 'it-pipe'

                                                      const { stream, protocol } = await libp2p.dialProtocol(remotePeerId, protocols)

                                                      // Use this new stream like any other duplex stream
                                                      pipe([1, 2, 3], stream, consume)
                                                      -

                                                    dispatchEvent

                                                    • dispatchEvent(event): boolean

                                                    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                      +

                                                    dispatchEvent

                                                    • dispatchEvent(event): boolean

                                                    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                      MDN Reference

                                                      Parameters

                                                      Returns boolean

                                                    • dispatchEvent(event): boolean

                                                    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                      MDN Reference

                                                      @@ -87,53 +87,53 @@

                                                      Example

                                                      for

                                                      Parameters

                                                      Returns Connection[]

                                                      Example

                                                      for (const connection of libp2p.getConnections()) {
                                                        console.log(peerId, connection.remoteAddr.toString())
                                                        // Logs the PeerId string and the observed remote multiaddr of each Connection
                                                      }
                                                      -

                                                    getDialQueue

                                                    getDialQueue

                                                    getMultiaddrs

                                                    getMultiaddrs

                                                    • getMultiaddrs(): Multiaddr[]

                                                    • Get a deduplicated list of peer advertising multiaddrs by concatenating the listen addresses used by transports with any configured announce addresses as well as observed addresses reported by peers.

                                                      If Announce addrs are specified, configured listen addresses will be ignored though observed addresses will still be included.

                                                      Returns Multiaddr[]

                                                      Example

                                                      const listenMa = libp2p.getMultiaddrs()
                                                      // [ <Multiaddr 047f00000106f9ba - /ip4/127.0.0.1/tcp/63930> ]
                                                      -

                                                    getPeers

                                                    getProtocols

                                                    getPeers

                                                    getProtocols

                                                    • getProtocols(): string[]

                                                    • Returns a list of supported protocols

                                                      Returns string[]

                                                      Example

                                                      const protocols = libp2p.getProtocols()
                                                      // [ '/ipfs/ping/1.0.0', '/ipfs/id/1.0.0' ]
                                                      -

                                                    getPublicKey

                                                    getPublicKey

                                                    handle

                                                    handle

                                                    • handle(protocol, handler, options?): Promise<void>

                                                    • Sets up multistream-select routing of protocols to their application handlers. Whenever a stream is opened on one of the provided protocols, the handler will be called. handle must be called in order to register a handler and support for a given protocol. This also informs other peers of the protocols you support.

                                                      libp2p.handle(protocols, handler, options)

                                                      In the event of a new handler for the same protocol being added, the first one is discarded.

                                                      Parameters

                                                      Returns Promise<void>

                                                      Example

                                                      const handler = ({ connection, stream, protocol }) => {
                                                        // use stream or connection according to the needs
                                                      }

                                                      libp2p.handle('/echo/1.0.0', handler, {
                                                        maxInboundStreams: 5,
                                                        maxOutboundStreams: 5
                                                      })
                                                      -

                                                    hangUp

                                                    hangUp

                                                    • hangUp(peer, options?): Promise<void>

                                                    • Attempts to gracefully close an open connection to the given peer. If the connection is not closed in the grace period, it will be forcefully closed.

                                                      An AbortSignal can optionally be passed to control when the connection is forcefully closed.

                                                      Parameters

                                                      Returns Promise<void>

                                                      Example

                                                      await libp2p.hangUp(remotePeerId)
                                                      -

                                                    isDialable

                                                    isDialable

                                                    • isDialable(multiaddr, options?): Promise<boolean>

                                                    • Given the current node configuration, returns a promise of true or false if the node would attempt to dial the passed multiaddr.

                                                      This means a relevant transport is configured, and the connection gater would not block the dial attempt.

                                                      This may involve resolving DNS addresses so you should pass an AbortSignal.

                                                      -

                                                      Parameters

                                                      Returns Promise<boolean>

                                                    listenerCount

                                                    register

                                                    listenerCount

                                                    register

                                                    • register(protocol, topology): Promise<string>

                                                    • Register a topology to be informed when peers are encountered that support the specified protocol

                                                      Parameters

                                                      Returns Promise<string>

                                                      Example

                                                      const id = await libp2p.register('/echo/1.0.0', {
                                                        onConnect: (peer, connection) => {
                                                          // handle connect
                                                        },
                                                        onDisconnect: (peer, connection) => {
                                                          // handle disconnect
                                                        }
                                                      })
                                                      -

                                                    removeEventListener

                                                    safeDispatchEvent

                                                    start

                                                    removeEventListener

                                                    safeDispatchEvent

                                                    start

                                                    stop

                                                    stop

                                                    unhandle

                                                    unhandle

                                                    • unhandle(protocols): Promise<void>

                                                    • Removes the handler for each protocol. The protocol will no longer be supported on streams.

                                                      Parameters

                                                      • protocols: string | string[]

                                                      Returns Promise<void>

                                                      Example

                                                      libp2p.unhandle(['/echo/1.0.0'])
                                                      -

                                                    unregister

                                                    unregister

                                                    • unregister(id): void

                                                    • Unregister topology to no longer be informed when peers connect or disconnect.

                                                      Parameters

                                                      • id: string

                                                      Returns void

                                                      Example

                                                      const id = await libp2p.register(...)

                                                      libp2p.unregister(id)
                                                      -

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    contentRoutingloggermetricspeerIdpeerRoutingpeerStoreservicesstatusaddEventListenerafterStartafterStopbeforeStartbeforeStopdialdialProtocoldispatchEventgetConnectionsgetDialQueuegetMultiaddrsgetPeersgetProtocolsgetPublicKeyhandlehangUpisDialablelistenerCountregisterremoveEventListenersafeDispatchEventstartstopunhandleunregister
                                                    \ No newline at end of file +

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    contentRoutingloggermetricspeerIdpeerRoutingpeerStoreservicesstatusaddEventListenerafterStartafterStopbeforeStartbeforeStopdialdialProtocoldispatchEventgetConnectionsgetDialQueuegetMultiaddrsgetPeersgetProtocolsgetPublicKeyhandlehangUpisDialablelistenerCountregisterremoveEventListenersafeDispatchEventstartstopunhandleunregister
                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Libp2pEvents.html b/interfaces/_libp2p_interface.Libp2pEvents.html index 9ef837e120..21ff1a383a 100644 --- a/interfaces/_libp2p_interface.Libp2pEvents.html +++ b/interfaces/_libp2p_interface.Libp2pEvents.html @@ -2,7 +2,7 @@ so that you can be notified of relevant network events.

                                                    Event names are noun:verb so the first part is the name of the object being acted on and the second is the action.

                                                    -
                                                    interface Libp2pEvents<T> {
                                                        certificate:provision: CustomEvent<TLSCertificate>;
                                                        certificate:renew: CustomEvent<TLSCertificate>;
                                                        connection:close: CustomEvent<Connection>;
                                                        connection:open: CustomEvent<Connection>;
                                                        connection:prune: CustomEvent<Connection[]>;
                                                        peer:connect: CustomEvent<PeerId>;
                                                        peer:disconnect: CustomEvent<PeerId>;
                                                        peer:discovery: CustomEvent<PeerInfo>;
                                                        peer:identify: CustomEvent<IdentifyResult>;
                                                        peer:reconnect-failure: CustomEvent<PeerId>;
                                                        peer:update: CustomEvent<PeerUpdate>;
                                                        self:peer:update: CustomEvent<PeerUpdate>;
                                                        start: CustomEvent<Libp2p<T>>;
                                                        stop: CustomEvent<Libp2p<T>>;
                                                        transport:close: CustomEvent<Listener>;
                                                        transport:listening: CustomEvent<Listener>;
                                                    }

                                                    Type Parameters

                                                    Properties

                                                    certificate:provision +
                                                    interface Libp2pEvents<T> {
                                                        certificate:provision: CustomEvent<TLSCertificate>;
                                                        certificate:renew: CustomEvent<TLSCertificate>;
                                                        connection:close: CustomEvent<Connection>;
                                                        connection:open: CustomEvent<Connection>;
                                                        connection:prune: CustomEvent<Connection[]>;
                                                        peer:connect: CustomEvent<PeerId>;
                                                        peer:disconnect: CustomEvent<PeerId>;
                                                        peer:discovery: CustomEvent<PeerInfo>;
                                                        peer:identify: CustomEvent<IdentifyResult>;
                                                        peer:reconnect-failure: CustomEvent<PeerId>;
                                                        peer:update: CustomEvent<PeerUpdate>;
                                                        self:peer:update: CustomEvent<PeerUpdate>;
                                                        start: CustomEvent<Libp2p<T>>;
                                                        stop: CustomEvent<Libp2p<T>>;
                                                        transport:close: CustomEvent<Listener>;
                                                        transport:listening: CustomEvent<Listener>;
                                                    }

                                                    Type Parameters

                                                    Properties

                                                    certificate:provision certificate:renew connection:close connection:open @@ -19,55 +19,55 @@ transport:close transport:listening

                                                    Properties

                                                    certificate:provision

                                                    certificate:provision: CustomEvent<TLSCertificate>

                                                    This event notifies listeners that a TLS certificate is available for use

                                                    -

                                                    certificate:renew

                                                    certificate:renew: CustomEvent<TLSCertificate>

                                                    This event notifies listeners that a new TLS certificate is available for +

                                                    certificate:renew

                                                    certificate:renew: CustomEvent<TLSCertificate>

                                                    This event notifies listeners that a new TLS certificate is available for use. Any previous certificate may no longer be valid.

                                                    -

                                                    connection:close

                                                    connection:close: CustomEvent<Connection>

                                                    This event notifies listeners when incoming or outgoing connections are +

                                                    connection:close

                                                    connection:close: CustomEvent<Connection>

                                                    This event notifies listeners when incoming or outgoing connections are closed.

                                                    -

                                                    connection:open

                                                    connection:open: CustomEvent<Connection>

                                                    This event notifies listeners when new incoming or outgoing connections +

                                                    connection:open

                                                    connection:open: CustomEvent<Connection>

                                                    This event notifies listeners when new incoming or outgoing connections are opened.

                                                    -

                                                    connection:prune

                                                    connection:prune: CustomEvent<Connection[]>

                                                    This event is dispatched when the connection manager has more than the +

                                                    connection:prune

                                                    connection:prune: CustomEvent<Connection[]>

                                                    This event is dispatched when the connection manager has more than the configured allowable max connections and has closed some connections to bring the node back under the limit.

                                                    -

                                                    peer:connect

                                                    peer:connect: CustomEvent<PeerId>

                                                    This event will be triggered any time a new peer connects.

                                                    +

                                                    peer:connect

                                                    peer:connect: CustomEvent<PeerId>

                                                    This event will be triggered any time a new peer connects.

                                                    Example

                                                    libp2p.addEventListener('peer:connect', (event) => {
                                                      const peerId = event.detail
                                                      // ...
                                                    })
                                                    -

                                                    peer:disconnect

                                                    peer:disconnect: CustomEvent<PeerId>

                                                    This event will be triggered any time we are disconnected from another +

                                                    peer:disconnect

                                                    peer:disconnect: CustomEvent<PeerId>

                                                    This event will be triggered any time we are disconnected from another peer, regardless of the circumstances of that disconnection. If we happen to have multiple connections to a peer, this event will only be triggered when the last connection is closed.

                                                    Example

                                                    libp2p.addEventListener('peer:disconnect', (event) => {
                                                      const peerId = event.detail
                                                      // ...
                                                    })
                                                    -

                                                    peer:discovery

                                                    peer:discovery: CustomEvent<PeerInfo>

                                                    This event is dispatched when a new network peer is discovered.

                                                    +

                                                    peer:discovery

                                                    peer:discovery: CustomEvent<PeerInfo>

                                                    This event is dispatched when a new network peer is discovered.

                                                    Example

                                                    libp2p.addEventListener('peer:discovery', (event) => {
                                                       const peerInfo = event.detail
                                                       // ...
                                                    })
                                                    -

                                                    peer:identify

                                                    peer:identify: CustomEvent<IdentifyResult>

                                                    This event is dispatched after a remote peer has successfully responded to +

                                                    peer:identify

                                                    peer:identify: CustomEvent<IdentifyResult>

                                                    This event is dispatched after a remote peer has successfully responded to the identify protocol. Note that for this to be emitted, both peers must have an identify service configured.

                                                    Example

                                                    libp2p.addEventListener('peer:identify', (event) => {
                                                      const identifyResult = event.detail
                                                      // ...
                                                    })
                                                    -

                                                    peer:reconnect-failure

                                                    peer:reconnect-failure: CustomEvent<PeerId>

                                                    When a peer tagged with keep-alive disconnects, we will make multiple +

                                                    peer:reconnect-failure

                                                    peer:reconnect-failure: CustomEvent<PeerId>

                                                    When a peer tagged with keep-alive disconnects, we will make multiple attempts to reconnect to it with a backoff factor (see the connection manager settings for details). If these all fail, the keep-alive tag will be removed and this event will be emitted.

                                                    Example

                                                    libp2p.addEventListener('peer:reconnect-failure', (event) => {
                                                      const peerId = event.detail
                                                      // ...
                                                    })
                                                    -

                                                    peer:update

                                                    peer:update: CustomEvent<PeerUpdate>

                                                    This event is dispatched when the peer store data for a peer has been +

                                                    peer:update

                                                    peer:update: CustomEvent<PeerUpdate>

                                                    This event is dispatched when the peer store data for a peer has been updated - e.g. their multiaddrs, protocols etc have changed.

                                                    If they were previously known to this node, the old peer data will be set in the previous field.

                                                    This may be in response to the identify protocol running, a manual update or some other event.

                                                    -

                                                    self:peer:update

                                                    self:peer:update: CustomEvent<PeerUpdate>

                                                    This event is dispatched when the current node's peer record changes - +

                                                    self:peer:update

                                                    self:peer:update: CustomEvent<PeerUpdate>

                                                    This event is dispatched when the current node's peer record changes - for example a transport started listening on a new address or a new protocol handler was registered.

                                                    Example

                                                    libp2p.addEventListener('self:peer:update', (event) => {
                                                      const { peer } = event.detail
                                                      // ...
                                                    })
                                                    -

                                                    start

                                                    start: CustomEvent<Libp2p<T>>

                                                    This event notifies listeners that the node has started

                                                    +

                                                    start

                                                    start: CustomEvent<Libp2p<T>>

                                                    This event notifies listeners that the node has started

                                                    libp2p.addEventListener('start', (event) => {
                                                      console.info(libp2p.isStarted()) // true
                                                    })
                                                    -

                                                    stop

                                                    stop: CustomEvent<Libp2p<T>>

                                                    This event notifies listeners that the node has stopped

                                                    +

                                                    stop

                                                    stop: CustomEvent<Libp2p<T>>

                                                    This event notifies listeners that the node has stopped

                                                    libp2p.addEventListener('stop', (event) => {
                                                      console.info(libp2p.isStarted()) // false
                                                    })
                                                    -

                                                    transport:close

                                                    transport:close: CustomEvent<Listener>

                                                    This event is dispatched when a transport stops listening on an address

                                                    -

                                                    transport:listening

                                                    transport:listening: CustomEvent<Listener>

                                                    This event is dispatched when a transport begins listening on a new address

                                                    -

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    certificate:provisioncertificate:renewconnection:closeconnection:openconnection:prunepeer:connectpeer:disconnectpeer:discoverypeer:identifypeer:reconnect-failurepeer:updateself:peer:updatestartstoptransport:closetransport:listening
                                                    \ No newline at end of file +

                                                    transport:close

                                                    transport:close: CustomEvent<Listener>

                                                    This event is dispatched when a transport stops listening on an address

                                                    +

                                                    transport:listening

                                                    transport:listening: CustomEvent<Listener>

                                                    This event is dispatched when a transport begins listening on a new address

                                                    +

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    certificate:provisioncertificate:renewconnection:closeconnection:openconnection:prunepeer:connectpeer:disconnectpeer:discoverypeer:identifypeer:reconnect-failurepeer:updateself:peer:updatestartstoptransport:closetransport:listening
                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Listener.html b/interfaces/_libp2p_interface.Listener.html index fbb3e10ee9..f2f36f4ea5 100644 --- a/interfaces/_libp2p_interface.Listener.html +++ b/interfaces/_libp2p_interface.Listener.html @@ -3,7 +3,7 @@ https://github.com/microsoft/TypeScript/issues/43477 https://github.com/microsoft/TypeScript/issues/299 etc

                                                    -
                                                    interface Listener {
                                                        addEventListener<K>(type, listener, options?): void;
                                                        close(): Promise<void>;
                                                        dispatchEvent(event): boolean;
                                                        dispatchEvent(event): boolean;
                                                        getAddrs(): Multiaddr[];
                                                        listen(multiaddr): Promise<void>;
                                                        listenerCount(type): number;
                                                        removeEventListener<K>(type, listener?, options?): void;
                                                        removeEventListener(type, listener?, options?): void;
                                                        safeDispatchEvent<Detail>(type, detail): boolean;
                                                    }

                                                    Hierarchy (view full)

                                                    Methods

                                                    addEventListener +
                                                    interface Listener {
                                                        addEventListener<K>(type, listener, options?): void;
                                                        close(): Promise<void>;
                                                        dispatchEvent(event): boolean;
                                                        dispatchEvent(event): boolean;
                                                        getAddrs(): Multiaddr[];
                                                        listen(multiaddr): Promise<void>;
                                                        listenerCount(type): number;
                                                        removeEventListener<K>(type, listener?, options?): void;
                                                        removeEventListener(type, listener?, options?): void;
                                                        safeDispatchEvent<Detail>(type, detail): boolean;
                                                    }

                                                    Hierarchy (view full)

                                                    Methods

                                                    addEventListener close dispatchEvent getAddrs @@ -11,11 +11,11 @@ listenerCount removeEventListener safeDispatchEvent -

                                                    Methods

                                                    addEventListener

                                                    close

                                                    dispatchEvent

                                                    • dispatchEvent(event): boolean

                                                    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                      +

                                                    Methods

                                                    addEventListener

                                                    close

                                                    dispatchEvent

                                                    • dispatchEvent(event): boolean

                                                    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                      MDN Reference

                                                      Parameters

                                                      Returns boolean

                                                    • dispatchEvent(event): boolean

                                                    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                      MDN Reference

                                                      Parameters

                                                      Returns boolean

                                                    getAddrs

                                                    listen

                                                    listenerCount

                                                    removeEventListener

                                                    safeDispatchEvent

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    addEventListenerclosedispatchEventgetAddrslistenlistenerCountremoveEventListenersafeDispatchEvent
                                                    \ No newline at end of file +

                                                    Returns Multiaddr[]

                                                    listen

                                                    listenerCount

                                                    removeEventListener

                                                    safeDispatchEvent

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    addEventListenerclosedispatchEventgetAddrslistenlistenerCountremoveEventListenersafeDispatchEvent
                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.ListenerEvents.html b/interfaces/_libp2p_interface.ListenerEvents.html index 51de2fc18e..2e1dc7a82d 100644 --- a/interfaces/_libp2p_interface.ListenerEvents.html +++ b/interfaces/_libp2p_interface.ListenerEvents.html @@ -1,9 +1,9 @@ -ListenerEvents | libp2p

                                                    Interface ListenerEvents

                                                    interface ListenerEvents {
                                                        close: CustomEvent<any>;
                                                        error: CustomEvent<Error>;
                                                        listening: CustomEvent<any>;
                                                    }

                                                    Properties

                                                    close +ListenerEvents | libp2p

                                                    Interface ListenerEvents

                                                    interface ListenerEvents {
                                                        close: CustomEvent<any>;
                                                        error: CustomEvent<Error>;
                                                        listening: CustomEvent<any>;
                                                    }

                                                    Properties

                                                    close error listening

                                                    Properties

                                                    close

                                                    close: CustomEvent<any>

                                                    Emitted when the listener has been shut down, has no open connections and will no longer accept new connections

                                                    -

                                                    error

                                                    error: CustomEvent<Error>

                                                    Emitted if listening on an address failed

                                                    -

                                                    listening

                                                    listening: CustomEvent<any>

                                                    This event signals to the transport manager that the listening addresses +

                                                    error

                                                    error: CustomEvent<Error>

                                                    Emitted if listening on an address failed

                                                    +

                                                    listening

                                                    listening: CustomEvent<any>

                                                    This event signals to the transport manager that the listening addresses have changed and may be emitted at any point and/or multiple times

                                                    -

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    closeerrorlistening
                                                    \ No newline at end of file +

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    closeerrorlistening
                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Logger.html b/interfaces/_libp2p_interface.Logger.html index 0d7dcca183..234e299f7d 100644 --- a/interfaces/_libp2p_interface.Logger.html +++ b/interfaces/_libp2p_interface.Logger.html @@ -1,5 +1,5 @@ Logger | libp2p

                                                    Interface Logger

                                                    Logger component for libp2p

                                                    -
                                                    interface Logger {
                                                        enabled: boolean;
                                                        error(formatter, ...args): void;
                                                        trace(formatter, ...args): void;
                                                        (formatter, ...args): void;
                                                    }

                                                    Properties

                                                    enabled +
                                                    interface Logger {
                                                        enabled: boolean;
                                                        error(formatter, ...args): void;
                                                        trace(formatter, ...args): void;
                                                        (formatter, ...args): void;
                                                    }

                                                    Properties

                                                    enabled

                                                    Methods

                                                    error trace -

                                                    Properties

                                                    enabled

                                                    enabled: boolean

                                                    Methods

                                                    error

                                                    trace

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    enablederrortrace
                                                    \ No newline at end of file +

                                                    Properties

                                                    enabled

                                                    enabled: boolean

                                                    Methods

                                                    error

                                                    trace

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    On This Page

                                                    enablederrortrace
                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.LoggerOptions.html b/interfaces/_libp2p_interface.LoggerOptions.html index f1723f3ebe..41b1629987 100644 --- a/interfaces/_libp2p_interface.LoggerOptions.html +++ b/interfaces/_libp2p_interface.LoggerOptions.html @@ -1,3 +1,3 @@ LoggerOptions | libp2p

                                                    Interface LoggerOptions

                                                    An object that contains a Logger as the log property.

                                                    -
                                                    interface LoggerOptions {
                                                        log: Logger;
                                                    }

                                                    Hierarchy

                                                    • LoggerOptions

                                                      Properties

                                                      log -

                                                      Properties

                                                      log

                                                      log: Logger

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      log
                                                      \ No newline at end of file +
                                                      interface LoggerOptions {
                                                          log: Logger;
                                                      }

                                                      Hierarchy

                                                      Properties

                                                      log +

                                                      Properties

                                                      log

                                                      log: Logger

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      log
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Metric.html b/interfaces/_libp2p_interface.Metric.html index f76bf58f65..ad36be76d4 100644 --- a/interfaces/_libp2p_interface.Metric.html +++ b/interfaces/_libp2p_interface.Metric.html @@ -1,14 +1,14 @@ Metric | libp2p

                                                      Interface Metric

                                                      A tracked metric loosely based on the interfaces exposed by the prom-client module

                                                      -
                                                      interface Metric {
                                                          decrement(value?): void;
                                                          increment(value?): void;
                                                          reset(): void;
                                                          timer(): StopTimer;
                                                          update(value): void;
                                                      }

                                                      Methods

                                                      decrement +
                                                      interface Metric {
                                                          decrement(value?): void;
                                                          increment(value?): void;
                                                          reset(): void;
                                                          timer(): StopTimer;
                                                          update(value): void;
                                                      }

                                                      Methods

                                                      decrement increment reset timer update

                                                      Methods

                                                      decrement

                                                      increment

                                                      reset

                                                      timer

                                                      increment

                                                      reset

                                                      timer

                                                      update

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      decrementincrementresettimerupdate
                                                      \ No newline at end of file +

                                                      Returns StopTimer

                                                      update

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      decrementincrementresettimerupdate
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.MetricGroup.html b/interfaces/_libp2p_interface.MetricGroup.html index 1fecc3cae9..74e93222ad 100644 --- a/interfaces/_libp2p_interface.MetricGroup.html +++ b/interfaces/_libp2p_interface.MetricGroup.html @@ -1,17 +1,17 @@ MetricGroup | libp2p

                                                      Interface MetricGroup<T>

                                                      A group of related metrics loosely based on the interfaces exposed by the prom-client module

                                                      -
                                                      interface MetricGroup<T> {
                                                          decrement(values): void;
                                                          increment(values): void;
                                                          reset(): void;
                                                          timer(key): StopTimer;
                                                          update(values): void;
                                                      }

                                                      Type Parameters

                                                      • T extends string = any

                                                      Methods

                                                      decrement +
                                                      interface MetricGroup<T> {
                                                          decrement(values): void;
                                                          increment(values): void;
                                                          reset(): void;
                                                          timer(key): StopTimer;
                                                          update(values): void;
                                                      }

                                                      Type Parameters

                                                      • T extends string = any

                                                      Methods

                                                      decrement increment reset timer update

                                                      Methods

                                                      decrement

                                                      increment

                                                      increment

                                                      reset

                                                      reset

                                                      timer

                                                      timer

                                                      update

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      decrementincrementresettimerupdate
                                                      \ No newline at end of file +

                                                      Parameters

                                                      Returns StopTimer

                                                      update

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      decrementincrementresettimerupdate
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.MetricOptions.html b/interfaces/_libp2p_interface.MetricOptions.html index 3cd77637f1..524f37fc21 100644 --- a/interfaces/_libp2p_interface.MetricOptions.html +++ b/interfaces/_libp2p_interface.MetricOptions.html @@ -1,7 +1,7 @@ MetricOptions | libp2p

                                                      Interface MetricOptions

                                                      Create tracked metrics with these options. Loosely based on the interfaces exposed by the prom-client module

                                                      -
                                                      interface MetricOptions {
                                                          help?: string;
                                                          label?: string;
                                                      }

                                                      Hierarchy (view full)

                                                      Properties

                                                      help? +
                                                      interface MetricOptions {
                                                          help?: string;
                                                          label?: string;
                                                      }

                                                      Hierarchy (view full)

                                                      Properties

                                                      help? label?

                                                      Properties

                                                      Optional help

                                                      help?: string

                                                      Optional help for the metric

                                                      -

                                                      Optional label

                                                      label?: string

                                                      Optional label for the metric

                                                      -

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      helplabel
                                                      \ No newline at end of file +

                                                      Optional label

                                                      label?: string

                                                      Optional label for the metric

                                                      +

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      helplabel
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Metrics.html b/interfaces/_libp2p_interface.Metrics.html index 3316a1edab..1b938f0933 100644 --- a/interfaces/_libp2p_interface.Metrics.html +++ b/interfaces/_libp2p_interface.Metrics.html @@ -16,7 +16,7 @@

                                                      Example: How to track multiaddr connections

                                                      This is something only li

                                                      Example: How to track protocol streams

                                                      This is something only libp2p connections need to do.

                                                      import { Metrics } from '@libp2p/interface/metrics'

                                                      interface MyServiceComponents {
                                                        metrics: Metrics
                                                      }

                                                      class MyService {
                                                        private readonly metrics: Metrics

                                                        constructor (components: MyServiceComponents) {
                                                          this.metrics = components.metrics
                                                        }

                                                        // later
                                                        doSomething () {
                                                          const stream = {} // create a stream
                                                          this.metrics.trackProtocolStream(stream)
                                                        }
                                                      }
                                                      -
                                                      interface Metrics {
                                                          registerCounter: ((name, options?) => Counter) & ((name, options) => void);
                                                          registerCounterGroup: ((name, options?) => CounterGroup<any>) & ((name, options) => void);
                                                          registerHistogram: ((name, options?) => Histogram) & ((name, options) => void);
                                                          registerHistogramGroup: ((name, options?) => HistogramGroup<any>) & ((name, options) => void);
                                                          registerMetric: ((name, options?) => Metric) & ((name, options) => void);
                                                          registerMetricGroup: ((name, options?) => MetricGroup<any>) & ((name, options) => void);
                                                          registerSummary: ((name, options?) => Summary) & ((name, options) => void);
                                                          registerSummaryGroup: ((name, options?) => SummaryGroup<any>) & ((name, options) => void);
                                                          createTrace(): any;
                                                          traceFunction<F>(name, fn, options?): F;
                                                          traceFunction<F>(name, fn, options?): F;
                                                          traceFunction<F>(name, fn, options?): F;
                                                          trackMultiaddrConnection(maConn): void;
                                                          trackProtocolStream(stream, connection): void;
                                                      }

                                                      Properties

                                                      registerCounter +
                                                      interface Metrics {
                                                          registerCounter: ((name, options?) => Counter) & ((name, options) => void);
                                                          registerCounterGroup: ((name, options?) => CounterGroup<any>) & ((name, options) => void);
                                                          registerHistogram: ((name, options?) => Histogram) & ((name, options) => void);
                                                          registerHistogramGroup: ((name, options?) => HistogramGroup<any>) & ((name, options) => void);
                                                          registerMetric: ((name, options?) => Metric) & ((name, options) => void);
                                                          registerMetricGroup: ((name, options?) => MetricGroup<any>) & ((name, options) => void);
                                                          registerSummary: ((name, options?) => Summary) & ((name, options) => void);
                                                          registerSummaryGroup: ((name, options?) => SummaryGroup<any>) & ((name, options) => void);
                                                          createTrace(): any;
                                                          traceFunction<F>(name, fn, options?): F;
                                                          traceFunction<F>(name, fn, options?): F;
                                                          traceFunction<F>(name, fn, options?): F;
                                                          trackMultiaddrConnection(maConn): void;
                                                          trackProtocolStream(stream, connection): void;
                                                      }

                                                      Properties

                                                      registerCounter registerCounterGroup registerHistogram registerHistogramGroup @@ -30,30 +30,30 @@

                                                      Example: How to track protocol streams

                                                      This is something only libp2p trackProtocolStream

                                                      Properties

                                                      registerCounter

                                                      registerCounter: ((name, options?) => Counter) & ((name, options) => void)

                                                      Register an arbitrary counter. Call this to set help/labels for counters and increment them by calling methods on the returned counter object

                                                      -

                                                      Type declaration

                                                      Type declaration

                                                      registerCounterGroup

                                                      registerCounterGroup: ((name, options?) => CounterGroup<any>) & ((name, options) => void)

                                                      Register a a group of related counters. Call this to set help/labels for +

                                                      Type declaration

                                                      Type declaration

                                                      registerCounterGroup

                                                      registerCounterGroup: ((name, options?) => CounterGroup<any>) & ((name, options) => void)

                                                      Register a a group of related counters. Call this to set help/labels for groups of related counters that will be updated with by calling the .increment method on the returned counter group object

                                                      -

                                                      Type declaration

                                                      Type declaration

                                                      registerHistogram

                                                      registerHistogram: ((name, options?) => Histogram) & ((name, options) => void)

                                                      Register an arbitrary histogram. Call this to set help/labels for histograms +

                                                      Type declaration

                                                      Type declaration

                                                      registerHistogram

                                                      registerHistogram: ((name, options?) => Histogram) & ((name, options) => void)

                                                      Register an arbitrary histogram. Call this to set help/labels for histograms and observe them by calling methods on the returned histogram object

                                                      -

                                                      Type declaration

                                                      Type declaration

                                                      registerHistogramGroup

                                                      registerHistogramGroup: ((name, options?) => HistogramGroup<any>) & ((name, options) => void)

                                                      Register a a group of related histograms. Call this to set help/labels for +

                                                      Type declaration

                                                      Type declaration

                                                      registerHistogramGroup

                                                      registerHistogramGroup: ((name, options?) => HistogramGroup<any>) & ((name, options) => void)

                                                      Register a a group of related histograms. Call this to set help/labels for groups of related histograms that will be updated with by calling the .observe method on the returned histogram group object

                                                      -

                                                      Type declaration

                                                      Type declaration

                                                      registerMetric

                                                      registerMetric: ((name, options?) => Metric) & ((name, options) => void)

                                                      Register an arbitrary metric. Call this to set help/labels for metrics +

                                                      Type declaration

                                                      Type declaration

                                                      registerMetric

                                                      registerMetric: ((name, options?) => Metric) & ((name, options) => void)

                                                      Register an arbitrary metric. Call this to set help/labels for metrics and update/increment/decrement/etc them by calling methods on the returned metric object

                                                      -

                                                      Type declaration

                                                      Type declaration

                                                      registerMetricGroup

                                                      registerMetricGroup: ((name, options?) => MetricGroup<any>) & ((name, options) => void)

                                                      Register a a group of related metrics. Call this to set help/labels for +

                                                      Type declaration

                                                      Type declaration

                                                      registerMetricGroup

                                                      registerMetricGroup: ((name, options?) => MetricGroup<any>) & ((name, options) => void)

                                                      Register a a group of related metrics. Call this to set help/labels for groups of related metrics that will be updated with by calling .update, .increment and/or .decrement methods on the returned metric group object

                                                      -

                                                      Type declaration

                                                      Type declaration

                                                      registerSummary

                                                      registerSummary: ((name, options?) => Summary) & ((name, options) => void)

                                                      Register an arbitrary summary. Call this to set help/labels for summaries +

                                                      Type declaration

                                                      Type declaration

                                                      registerSummary

                                                      registerSummary: ((name, options?) => Summary) & ((name, options) => void)

                                                      Register an arbitrary summary. Call this to set help/labels for summaries and observe them by calling methods on the returned summary object

                                                      -

                                                      Type declaration

                                                      Type declaration

                                                      registerSummaryGroup

                                                      registerSummaryGroup: ((name, options?) => SummaryGroup<any>) & ((name, options) => void)

                                                      Register a a group of related summaries. Call this to set help/labels for +

                                                      Type declaration

                                                      Type declaration

                                                      registerSummaryGroup

                                                      registerSummaryGroup: ((name, options?) => SummaryGroup<any>) & ((name, options) => void)

                                                      Register a a group of related summaries. Call this to set help/labels for groups of related summaries that will be updated with by calling the .observe method on the returned summary group object

                                                      -

                                                      Type declaration

                                                      Type declaration

                                                      Methods

                                                      createTrace

                                                      traceFunction

                                                      Methods

                                                      createTrace

                                                      traceFunction

                                                      trackMultiaddrConnection

                                                      trackProtocolStream

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      registerCounterregisterCounterGroupregisterHistogramregisterHistogramGroupregisterMetricregisterMetricGroupregisterSummaryregisterSummaryGroupcreateTracetraceFunctiontrackMultiaddrConnectiontrackProtocolStream
                                                      \ No newline at end of file +

                                                      Type Parameters

                                                      Parameters

                                                      Returns F

                                                    • traceFunction<F>(name, fn, options?): F

                                                    • Type Parameters

                                                      • F extends ((...args) => Iterator<any, any, undefined>)

                                                      Parameters

                                                      Returns F

                                                    • traceFunction<F>(name, fn, options?): F

                                                    • Type Parameters

                                                      • F extends ((...args) => any) = ((...args) => any)

                                                      Parameters

                                                      Returns F

                                                      • trackMultiaddrConnection

                                                      trackProtocolStream

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      registerCounterregisterCounterGroupregisterHistogramregisterHistogramGroupregisterMetricregisterMetricGroupregisterSummaryregisterSummaryGroupcreateTracetraceFunctiontrackMultiaddrConnectiontrackProtocolStream
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.MultiaddrConnection.html b/interfaces/_libp2p_interface.MultiaddrConnection.html index 52b34219c8..ea07140d4b 100644 --- a/interfaces/_libp2p_interface.MultiaddrConnection.html +++ b/interfaces/_libp2p_interface.MultiaddrConnection.html @@ -1,7 +1,7 @@ MultiaddrConnection | libp2p

                                                      Interface MultiaddrConnection

                                                      A MultiaddrConnection is returned by transports after dialing a peer. It is a low-level primitive and is the raw connection without encryption or stream multiplexing.

                                                      -
                                                      interface MultiaddrConnection {
                                                          log: Logger;
                                                          remoteAddr: Multiaddr;
                                                          sink: Sink<AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>, unknown>;
                                                          source: AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>;
                                                          timeline: MultiaddrConnectionTimeline;
                                                          abort(err): void;
                                                          close(options?): Promise<void>;
                                                      }

                                                      Hierarchy

                                                      Properties

                                                      log +
                                                      interface MultiaddrConnection {
                                                          log: Logger;
                                                          remoteAddr: Multiaddr;
                                                          sink: Sink<AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>, unknown>;
                                                          source: AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>;
                                                          timeline: MultiaddrConnectionTimeline;
                                                          abort(err): void;
                                                          close(options?): Promise<void>;
                                                      }

                                                      Hierarchy

                                                      Properties

                                                      log remoteAddr sink source @@ -9,9 +9,9 @@

                                                      Methods

                                                      abort close

                                                      Properties

                                                      log

                                                      log: Logger

                                                      The multiaddr connection logger

                                                      -

                                                      remoteAddr

                                                      remoteAddr: Multiaddr

                                                      The address of the remote end of the connection

                                                      -

                                                      sink

                                                      sink: Sink<AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>, unknown>

                                                      source

                                                      source: AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>

                                                      timeline

                                                      timeline: MultiaddrConnectionTimeline

                                                      When connection lifecycle events occurred

                                                      -

                                                      Methods

                                                      abort

                                                      close

                                                      remoteAddr

                                                      remoteAddr: Multiaddr

                                                      The address of the remote end of the connection

                                                      +

                                                      sink

                                                      sink: Sink<AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>, unknown>

                                                      source

                                                      source: AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>

                                                      timeline

                                                      timeline: MultiaddrConnectionTimeline

                                                      When connection lifecycle events occurred

                                                      +

                                                      Methods

                                                      abort

                                                      close

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      logremoteAddrsinksourcetimelineabortclose
                                                      \ No newline at end of file +

                                                      Parameters

                                                      Returns Promise<void>

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      logremoteAddrsinksourcetimelineabortclose
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.MultiaddrConnectionTimeline.html b/interfaces/_libp2p_interface.MultiaddrConnectionTimeline.html index ea4dcd2c9e..460a1d2f7f 100644 --- a/interfaces/_libp2p_interface.MultiaddrConnectionTimeline.html +++ b/interfaces/_libp2p_interface.MultiaddrConnectionTimeline.html @@ -1,8 +1,8 @@ -MultiaddrConnectionTimeline | libp2p

                                                      Interface MultiaddrConnectionTimeline

                                                      interface MultiaddrConnectionTimeline {
                                                          close?: number;
                                                          open: number;
                                                          upgraded?: number;
                                                      }

                                                      Properties

                                                      close? +MultiaddrConnectionTimeline | libp2p

                                                      Interface MultiaddrConnectionTimeline

                                                      interface MultiaddrConnectionTimeline {
                                                          close?: number;
                                                          open: number;
                                                          upgraded?: number;
                                                      }

                                                      Properties

                                                      close? open upgraded?

                                                      Properties

                                                      Optional close

                                                      close?: number

                                                      When the connection was closed.

                                                      -

                                                      open

                                                      open: number

                                                      When the connection was opened

                                                      -

                                                      Optional upgraded

                                                      upgraded?: number

                                                      When the MultiaddrConnection was upgraded to a Connection - the type of +

                                                      open

                                                      open: number

                                                      When the connection was opened

                                                      +

                                                      Optional upgraded

                                                      upgraded?: number

                                                      When the MultiaddrConnection was upgraded to a Connection - the type of connection encryption and multiplexing was negotiated.

                                                      -

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      closeopenupgraded
                                                      \ No newline at end of file +

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      closeopenupgraded
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.MultiaddrFilter.html b/interfaces/_libp2p_interface.MultiaddrFilter.html index 3809563574..3d4382d7f8 100644 --- a/interfaces/_libp2p_interface.MultiaddrFilter.html +++ b/interfaces/_libp2p_interface.MultiaddrFilter.html @@ -1 +1 @@ -MultiaddrFilter | libp2p

                                                      Interface MultiaddrFilter

                                                      interface MultiaddrFilter ((multiaddrs) => Multiaddr[])

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      \ No newline at end of file +MultiaddrFilter | libp2p

                                                      Interface MultiaddrFilter

                                                      interface MultiaddrFilter ((multiaddrs) => Multiaddr[])

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.NewStreamOptions.html b/interfaces/_libp2p_interface.NewStreamOptions.html index 1ba227e4f9..681dbda678 100644 --- a/interfaces/_libp2p_interface.NewStreamOptions.html +++ b/interfaces/_libp2p_interface.NewStreamOptions.html @@ -2,14 +2,14 @@ the optional signal property.

                                                      Example

                                                      const controller = new AbortController()

                                                      aLongRunningOperation({
                                                        signal: controller.signal
                                                      })

                                                      // later

                                                      controller.abort()
                                                      -
                                                      interface NewStreamOptions {
                                                          maxOutboundStreams?: number;
                                                          negotiateFully?: boolean;
                                                          runOnLimitedConnection?: boolean;
                                                          signal?: AbortSignal;
                                                      }

                                                      Hierarchy (view full)

                                                      Properties

                                                      maxOutboundStreams? +
                                                      interface NewStreamOptions {
                                                          maxOutboundStreams?: number;
                                                          negotiateFully?: boolean;
                                                          runOnLimitedConnection?: boolean;
                                                          signal?: AbortSignal;
                                                      }

                                                      Hierarchy (view full)

                                                      Properties

                                                      maxOutboundStreams? negotiateFully? runOnLimitedConnection? signal?

                                                      Properties

                                                      Optional maxOutboundStreams

                                                      maxOutboundStreams?: number

                                                      If specified, and no handler has been registered with the registrar for the successfully negotiated protocol, use this as the max outbound stream limit for the protocol

                                                      -

                                                      Optional negotiateFully

                                                      negotiateFully?: boolean

                                                      By default when negotiating a protocol the dialer writes then protocol name +

                                                      Optional negotiateFully

                                                      negotiateFully?: boolean

                                                      By default when negotiating a protocol the dialer writes then protocol name then reads the response.

                                                      When a only a single protocol is being negotiated on an outbound stream, and the stream is written to before being read from, we can optimistically @@ -27,11 +27,11 @@ in full before the stream is returned so this option has no effect.

                                                      Default

                                                      true
                                                      -

                                                      Optional runOnLimitedConnection

                                                      runOnLimitedConnection?: boolean

                                                      Opt-in to running over a limited connection - one that has restrictions +

                                                      Optional runOnLimitedConnection

                                                      runOnLimitedConnection?: boolean

                                                      Opt-in to running over a limited connection - one that has restrictions on the amount of data that may be transferred or how long it may be open for.

                                                      These limits are typically enforced by a relay server, if the protocol will be transferring a lot of data or the stream will be open for a long time consider upgrading to a direct connection before opening the stream.

                                                      Default

                                                      false
                                                      -

                                                      Optional signal

                                                      signal?: AbortSignal

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      maxOutboundStreamsnegotiateFullyrunOnLimitedConnectionsignal
                                                      \ No newline at end of file +

                                                      Optional signal

                                                      signal?: AbortSignal

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      maxOutboundStreamsnegotiateFullyrunOnLimitedConnectionsignal
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.NodeInfo.html b/interfaces/_libp2p_interface.NodeInfo.html index da08305531..472d450042 100644 --- a/interfaces/_libp2p_interface.NodeInfo.html +++ b/interfaces/_libp2p_interface.NodeInfo.html @@ -1,6 +1,6 @@ NodeInfo | libp2p

                                                      Interface NodeInfo

                                                      Metadata about the current node

                                                      -
                                                      interface NodeInfo {
                                                          name: string;
                                                          version: string;
                                                      }

                                                      Properties

                                                      name +
                                                      interface NodeInfo {
                                                          name: string;
                                                          version: string;
                                                      }

                                                      Properties

                                                      name version

                                                      Properties

                                                      name

                                                      name: string

                                                      The implementation name

                                                      -

                                                      version

                                                      version: string

                                                      The implementation version

                                                      -

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      nameversion
                                                      \ No newline at end of file +

                                                      version

                                                      version: string

                                                      The implementation version

                                                      +

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      nameversion
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Peer.html b/interfaces/_libp2p_interface.Peer.html index 081e7bf9c9..59a12907d2 100644 --- a/interfaces/_libp2p_interface.Peer.html +++ b/interfaces/_libp2p_interface.Peer.html @@ -1,5 +1,5 @@ Peer | libp2p

                                                      Interface Peer

                                                      Data stored in the peer store about peers

                                                      -
                                                      interface Peer {
                                                          addresses: Address[];
                                                          id: PeerId;
                                                          metadata: Map<string, Uint8Array>;
                                                          peerRecordEnvelope?: Uint8Array;
                                                          protocols: string[];
                                                          tags: Map<string, Tag>;
                                                      }

                                                      Properties

                                                      addresses +
                                                      interface Peer {
                                                          addresses: Address[];
                                                          id: PeerId;
                                                          metadata: Map<string, Uint8Array>;
                                                          peerRecordEnvelope?: Uint8Array;
                                                          protocols: string[];
                                                          tags: Map<string, Tag>;
                                                      }

                                                      Properties

                                                      addresses id metadata peerRecordEnvelope? @@ -7,9 +7,9 @@ tags

                                                      Properties

                                                      addresses

                                                      addresses: Address[]

                                                      Peer's addresses containing a list of multiaddrs and a isCertified field indicating if the address was loaded from a signed peer record or not

                                                      -

                                                      id

                                                      id: PeerId

                                                      Peer's peer-id instance

                                                      -

                                                      metadata

                                                      metadata: Map<string, Uint8Array>

                                                      Peer's metadata map

                                                      -

                                                      Optional peerRecordEnvelope

                                                      peerRecordEnvelope?: Uint8Array

                                                      The last peer record envelope received

                                                      -

                                                      protocols

                                                      protocols: string[]

                                                      Peer's supported protocols

                                                      -

                                                      tags

                                                      tags: Map<string, Tag>

                                                      Tags a peer has

                                                      -

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      addressesidmetadatapeerRecordEnvelopeprotocolstags
                                                      \ No newline at end of file +

                                                      id

                                                      id: PeerId

                                                      Peer's peer-id instance

                                                      +

                                                      metadata

                                                      metadata: Map<string, Uint8Array>

                                                      Peer's metadata map

                                                      +

                                                      Optional peerRecordEnvelope

                                                      peerRecordEnvelope?: Uint8Array

                                                      The last peer record envelope received

                                                      +

                                                      protocols

                                                      protocols: string[]

                                                      Peer's supported protocols

                                                      +

                                                      tags

                                                      tags: Map<string, Tag>

                                                      Tags a peer has

                                                      +

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      addressesidmetadatapeerRecordEnvelopeprotocolstags
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerData.html b/interfaces/_libp2p_interface.PeerData.html index 1a90db0b69..21c7e3bade 100644 --- a/interfaces/_libp2p_interface.PeerData.html +++ b/interfaces/_libp2p_interface.PeerData.html @@ -1,5 +1,5 @@ PeerData | libp2p

                                                      Interface PeerData

                                                      Peer data used to update the peer store

                                                      -
                                                      interface PeerData {
                                                          addresses?: Address[];
                                                          metadata?: Map<string, undefined | Uint8Array> | Record<string, undefined | Uint8Array>;
                                                          multiaddrs?: Multiaddr[];
                                                          peerRecordEnvelope?: Uint8Array;
                                                          protocols?: string[];
                                                          publicKey?: PublicKey;
                                                          tags?: Map<string, undefined | TagOptions> | Record<string, undefined | TagOptions>;
                                                      }

                                                      Properties

                                                      addresses? +
                                                      interface PeerData {
                                                          addresses?: Address[];
                                                          metadata?: Map<string, undefined | Uint8Array> | Record<string, undefined | Uint8Array>;
                                                          multiaddrs?: Multiaddr[];
                                                          peerRecordEnvelope?: Uint8Array;
                                                          protocols?: string[];
                                                          publicKey?: PublicKey;
                                                          tags?: Map<string, undefined | TagOptions> | Record<string, undefined | TagOptions>;
                                                      }

                                                      Properties

                                                      addresses? metadata? multiaddrs? peerRecordEnvelope? @@ -11,14 +11,14 @@ set to true.

                                                      If both addresses and multiaddrs are specified they will be merged together with entries in addresses taking precedence.

                                                      -

                                                      Optional metadata

                                                      metadata?: Map<string, undefined | Uint8Array> | Record<string, undefined | Uint8Array>

                                                      Peer's metadata map. When merging pass undefined as values to remove metadata.

                                                      -

                                                      Optional multiaddrs

                                                      multiaddrs?: Multiaddr[]

                                                      Peer's multiaddrs - any multiaddrs passed here will be treated as +

                                                      Optional metadata

                                                      metadata?: Map<string, undefined | Uint8Array> | Record<string, undefined | Uint8Array>

                                                      Peer's metadata map. When merging pass undefined as values to remove metadata.

                                                      +

                                                      Optional multiaddrs

                                                      multiaddrs?: Multiaddr[]

                                                      Peer's multiaddrs - any multiaddrs passed here will be treated as uncertified.

                                                      If both addresses and multiaddrs are specified they will be merged together with entries in addresses taking precedence.

                                                      -

                                                      Optional peerRecordEnvelope

                                                      peerRecordEnvelope?: Uint8Array

                                                      The last peer record envelope received

                                                      -

                                                      Optional protocols

                                                      protocols?: string[]

                                                      Peer's supported protocols

                                                      -

                                                      Optional publicKey

                                                      publicKey?: PublicKey

                                                      If this Peer has an RSA key, it's public key can be set with this property.

                                                      +

                                                      Optional peerRecordEnvelope

                                                      peerRecordEnvelope?: Uint8Array

                                                      The last peer record envelope received

                                                      +

                                                      Optional protocols

                                                      protocols?: string[]

                                                      Peer's supported protocols

                                                      +

                                                      Optional publicKey

                                                      publicKey?: PublicKey

                                                      If this Peer has an RSA key, it's public key can be set with this property.

                                                      The byte array should be the protobuf encoded form of the public key.

                                                      -

                                                      Optional tags

                                                      tags?: Map<string, undefined | TagOptions> | Record<string, undefined | TagOptions>

                                                      Peer tags. When merging pass undefined as values to remove tags.

                                                      -

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      addressesmetadatamultiaddrspeerRecordEnvelopeprotocolspublicKeytags
                                                      \ No newline at end of file +

                                                      Optional tags

                                                      tags?: Map<string, undefined | TagOptions> | Record<string, undefined | TagOptions>

                                                      Peer tags. When merging pass undefined as values to remove tags.

                                                      +

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      addressesmetadatamultiaddrspeerRecordEnvelopeprotocolspublicKeytags
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerDiscovery.html b/interfaces/_libp2p_interface.PeerDiscovery.html index 7b361aa1f0..ba855219c7 100644 --- a/interfaces/_libp2p_interface.PeerDiscovery.html +++ b/interfaces/_libp2p_interface.PeerDiscovery.html @@ -3,13 +3,13 @@ https://github.com/microsoft/TypeScript/issues/43477 https://github.com/microsoft/TypeScript/issues/299 etc

                                                      -
                                                      interface PeerDiscovery {
                                                          addEventListener<K>(type, listener, options?): void;
                                                          dispatchEvent(event): boolean;
                                                          dispatchEvent(event): boolean;
                                                          listenerCount(type): number;
                                                          removeEventListener<K>(type, listener?, options?): void;
                                                          removeEventListener(type, listener?, options?): void;
                                                          safeDispatchEvent<Detail>(type, detail): boolean;
                                                      }

                                                      Hierarchy (view full)

                                                      Methods

                                                      addEventListener +
                                                      interface PeerDiscovery {
                                                          addEventListener<K>(type, listener, options?): void;
                                                          dispatchEvent(event): boolean;
                                                          dispatchEvent(event): boolean;
                                                          listenerCount(type): number;
                                                          removeEventListener<K>(type, listener?, options?): void;
                                                          removeEventListener(type, listener?, options?): void;
                                                          safeDispatchEvent<Detail>(type, detail): boolean;
                                                      }

                                                      Hierarchy (view full)

                                                      Methods

                                                      addEventListener dispatchEvent listenerCount removeEventListener safeDispatchEvent -

                                                      Methods

                                                      addEventListener

                                                      dispatchEvent

                                                      • dispatchEvent(event): boolean

                                                      • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                        +

                                                      Methods

                                                      addEventListener

                                                      dispatchEvent

                                                      • dispatchEvent(event): boolean

                                                      • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                        MDN Reference

                                                        Parameters

                                                        Returns boolean

                                                      • dispatchEvent(event): boolean

                                                      • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                        MDN Reference

                                                        -

                                                        Parameters

                                                        Returns boolean

                                                      listenerCount

                                                      removeEventListener

                                                      safeDispatchEvent

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      addEventListenerdispatchEventlistenerCountremoveEventListenersafeDispatchEvent
                                                      \ No newline at end of file +

                                                      Parameters

                                                      Returns boolean

                                                      listenerCount

                                                      removeEventListener

                                                      safeDispatchEvent

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      addEventListenerdispatchEventlistenerCountremoveEventListenersafeDispatchEvent
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerDiscoveryEvents.html b/interfaces/_libp2p_interface.PeerDiscoveryEvents.html index c2ec5ba22a..827208eefc 100644 --- a/interfaces/_libp2p_interface.PeerDiscoveryEvents.html +++ b/interfaces/_libp2p_interface.PeerDiscoveryEvents.html @@ -1,2 +1,2 @@ -PeerDiscoveryEvents | libp2p

                                                      Interface PeerDiscoveryEvents

                                                      interface PeerDiscoveryEvents {
                                                          peer: CustomEvent<PeerInfo>;
                                                      }

                                                      Properties

                                                      peer -

                                                      Properties

                                                      peer

                                                      peer: CustomEvent<PeerInfo>

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      peer
                                                      \ No newline at end of file +PeerDiscoveryEvents | libp2p

                                                      Interface PeerDiscoveryEvents

                                                      interface PeerDiscoveryEvents {
                                                          peer: CustomEvent<PeerInfo>;
                                                      }

                                                      Properties

                                                      peer +

                                                      Properties

                                                      peer

                                                      peer: CustomEvent<PeerInfo>

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      peer
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerDiscoveryProvider.html b/interfaces/_libp2p_interface.PeerDiscoveryProvider.html index 4584b7747a..37a18391be 100644 --- a/interfaces/_libp2p_interface.PeerDiscoveryProvider.html +++ b/interfaces/_libp2p_interface.PeerDiscoveryProvider.html @@ -1,4 +1,4 @@ PeerDiscoveryProvider | libp2p

                                                      Interface PeerDiscoveryProvider

                                                      Implementers of this interface can provide a PeerDiscovery implementation to interested callers.

                                                      -
                                                      interface PeerDiscoveryProvider {
                                                          [peerDiscoverySymbol]: PeerDiscovery;
                                                      }

                                                      Properties

                                                      [peerDiscoverySymbol] -

                                                      Properties

                                                      [peerDiscoverySymbol]

                                                      [peerDiscoverySymbol]: PeerDiscovery

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      [peerDiscoverySymbol]
                                                      \ No newline at end of file +
                                                      interface PeerDiscoveryProvider {
                                                          [peerDiscoverySymbol]: PeerDiscovery;
                                                      }

                                                      Properties

                                                      [peerDiscoverySymbol] +

                                                      Properties

                                                      [peerDiscoverySymbol]

                                                      [peerDiscoverySymbol]: PeerDiscovery

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      [peerDiscoverySymbol]
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerInfo.html b/interfaces/_libp2p_interface.PeerInfo.html index 2a80699eb4..87a0addb06 100644 --- a/interfaces/_libp2p_interface.PeerInfo.html +++ b/interfaces/_libp2p_interface.PeerInfo.html @@ -1,8 +1,8 @@ PeerInfo | libp2p

                                                      Interface PeerInfo

                                                      A PeerInfo is a lightweight object that represents a remote peer, it can be obtained from peer discovery mechanisms, HTTP RPC endpoints, etc.

                                                      See

                                                      https://docs.libp2p.io/concepts/fundamentals/peers/#peer-info

                                                      -
                                                      interface PeerInfo {
                                                          id: PeerId;
                                                          multiaddrs: Multiaddr[];
                                                      }

                                                      Properties

                                                      id +
                                                      interface PeerInfo {
                                                          id: PeerId;
                                                          multiaddrs: Multiaddr[];
                                                      }

                                                      Properties

                                                      id multiaddrs

                                                      Properties

                                                      id

                                                      id: PeerId

                                                      The identifier of the remote peer

                                                      -

                                                      multiaddrs

                                                      multiaddrs: Multiaddr[]

                                                      The multiaddrs a peer is listening on

                                                      -

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      idmultiaddrs
                                                      \ No newline at end of file +

                                                      multiaddrs

                                                      multiaddrs: Multiaddr[]

                                                      The multiaddrs a peer is listening on

                                                      +

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      idmultiaddrs
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerQuery.html b/interfaces/_libp2p_interface.PeerQuery.html index 2a31d1d243..c1246fd930 100644 --- a/interfaces/_libp2p_interface.PeerQuery.html +++ b/interfaces/_libp2p_interface.PeerQuery.html @@ -1,6 +1,6 @@ PeerQuery | libp2p

                                                      Interface PeerQuery

                                                      A query for getting lists of peers

                                                      -
                                                      interface PeerQuery {
                                                          filters?: PeerQueryFilter[];
                                                          limit?: number;
                                                          offset?: number;
                                                          orders?: PeerQueryOrder[];
                                                      }

                                                      Properties

                                                      filters? +
                                                      interface PeerQuery {
                                                          filters?: PeerQueryFilter[];
                                                          limit?: number;
                                                          offset?: number;
                                                          orders?: PeerQueryOrder[];
                                                      }

                                                      Properties

                                                      filters? limit? offset? orders? -

                                                      Properties

                                                      Optional filters

                                                      filters?: PeerQueryFilter[]

                                                      Optional limit

                                                      limit?: number

                                                      Optional offset

                                                      offset?: number

                                                      Optional orders

                                                      orders?: PeerQueryOrder[]

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      filterslimitoffsetorders
                                                      \ No newline at end of file +

                                                      Properties

                                                      Optional filters

                                                      filters?: PeerQueryFilter[]

                                                      Optional limit

                                                      limit?: number

                                                      Optional offset

                                                      offset?: number

                                                      Optional orders

                                                      orders?: PeerQueryOrder[]

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      filterslimitoffsetorders
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerQueryFilter.html b/interfaces/_libp2p_interface.PeerQueryFilter.html index 3744b04ee9..cc94cc65d2 100644 --- a/interfaces/_libp2p_interface.PeerQueryFilter.html +++ b/interfaces/_libp2p_interface.PeerQueryFilter.html @@ -1,2 +1,2 @@ PeerQueryFilter | libp2p

                                                      Interface PeerQueryFilter

                                                      A predicate by which to filter lists of peers

                                                      -
                                                      interface PeerQueryFilter ((peer) => boolean)

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      \ No newline at end of file +
                                                      interface PeerQueryFilter ((peer) => boolean)

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerQueryOrder.html b/interfaces/_libp2p_interface.PeerQueryOrder.html index 4e77d03c47..039769b746 100644 --- a/interfaces/_libp2p_interface.PeerQueryOrder.html +++ b/interfaces/_libp2p_interface.PeerQueryOrder.html @@ -1,2 +1,2 @@ PeerQueryOrder | libp2p

                                                      Interface PeerQueryOrder

                                                      A predicate by which to sort lists of peers

                                                      -
                                                      interface PeerQueryOrder ((a, b) => -1 | 0 | 1)

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      \ No newline at end of file +
                                                      interface PeerQueryOrder ((a, b) => -1 | 0 | 1)

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerRouting.html b/interfaces/_libp2p_interface.PeerRouting.html index 4e090ba044..7d1ec9f97e 100644 --- a/interfaces/_libp2p_interface.PeerRouting.html +++ b/interfaces/_libp2p_interface.PeerRouting.html @@ -1,10 +1,10 @@ -PeerRouting | libp2p

                                                      Interface PeerRouting

                                                      interface PeerRouting {
                                                          findPeer(peerId, options?): Promise<PeerInfo>;
                                                          getClosestPeers(key, options?): AsyncIterable<PeerInfo>;
                                                      }

                                                      Methods

                                                      findPeer +PeerRouting | libp2p

                                                      Interface PeerRouting

                                                      interface PeerRouting {
                                                          findPeer(peerId, options?): Promise<PeerInfo>;
                                                          getClosestPeers(key, options?): AsyncIterable<PeerInfo>;
                                                      }

                                                      Methods

                                                      findPeer getClosestPeers

                                                      Methods

                                                      findPeer

                                                      getClosestPeers

                                                      getClosestPeers

                                                      • getClosestPeers(key, options?): AsyncIterable<PeerInfo>

                                                      • Search the network for peers that are closer to the passed key. Peer info should be yielded in ever-increasing closeness to the key.

                                                        Parameters

                                                        Returns AsyncIterable<PeerInfo>

                                                        Example

                                                        // Iterate over the closest peers found for the given key
                                                        for await (const peer of peerRouting.getClosestPeers(key)) {
                                                          console.log(peer.id, peer.multiaddrs)
                                                        }
                                                        -

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      findPeergetClosestPeers
                                                      \ No newline at end of file +

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      findPeergetClosestPeers
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerRoutingProvider.html b/interfaces/_libp2p_interface.PeerRoutingProvider.html index c1680c86e2..d74de69270 100644 --- a/interfaces/_libp2p_interface.PeerRoutingProvider.html +++ b/interfaces/_libp2p_interface.PeerRoutingProvider.html @@ -1,4 +1,4 @@ PeerRoutingProvider | libp2p

                                                      Interface PeerRoutingProvider

                                                      Implementers of this interface can provide a PeerRouting implementation to interested callers.

                                                      -
                                                      interface PeerRoutingProvider {
                                                          [peerRoutingSymbol]: PeerRouting;
                                                      }

                                                      Properties

                                                      [peerRoutingSymbol] -

                                                      Properties

                                                      [peerRoutingSymbol]

                                                      [peerRoutingSymbol]: PeerRouting

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      [peerRoutingSymbol]
                                                      \ No newline at end of file +
                                                      interface PeerRoutingProvider {
                                                          [peerRoutingSymbol]: PeerRouting;
                                                      }

                                                      Properties

                                                      [peerRoutingSymbol] +

                                                      Properties

                                                      [peerRoutingSymbol]

                                                      [peerRoutingSymbol]: PeerRouting

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      [peerRoutingSymbol]
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerStore.html b/interfaces/_libp2p_interface.PeerStore.html index d3fd6542ad..fbd3a9c6ae 100644 --- a/interfaces/_libp2p_interface.PeerStore.html +++ b/interfaces/_libp2p_interface.PeerStore.html @@ -1,4 +1,4 @@ -PeerStore | libp2p

                                                      Interface PeerStore

                                                      interface PeerStore {
                                                          all(query?): Promise<Peer[]>;
                                                          consumePeerRecord(buf, expectedPeer?): Promise<boolean>;
                                                          delete(peerId): Promise<void>;
                                                          forEach(fn, query?): Promise<void>;
                                                          get(peerId): Promise<Peer>;
                                                          has(peerId): Promise<boolean>;
                                                          merge(id, data): Promise<Peer>;
                                                          patch(id, data): Promise<Peer>;
                                                          save(id, data): Promise<Peer>;
                                                      }

                                                      Methods

                                                      all +PeerStore | libp2p

                                                      Interface PeerStore

                                                      interface PeerStore {
                                                          all(query?): Promise<Peer[]>;
                                                          consumePeerRecord(buf, expectedPeer?): Promise<boolean>;
                                                          delete(peerId): Promise<void>;
                                                          forEach(fn, query?): Promise<void>;
                                                          get(peerId): Promise<Peer>;
                                                          has(peerId): Promise<boolean>;
                                                          merge(id, data): Promise<Peer>;
                                                          patch(id, data): Promise<Peer>;
                                                          save(id, data): Promise<Peer>;
                                                      }

                                                      Methods

                                                      all consumePeerRecord delete forEach @@ -10,35 +10,35 @@

                                                      Methods

                                                      all

                                                      consumePeerRecord

                                                      consumePeerRecord

                                                      • consumePeerRecord(buf, expectedPeer?): Promise<boolean>

                                                      • Unmarshal and verify a signed peer record, extract the multiaddrs and overwrite the stored addresses for the peer.

                                                        Optionally pass an expected PeerId to verify that the peer record was signed by that peer.

                                                        Parameters

                                                        Returns Promise<boolean>

                                                        Example

                                                        await peerStore.consumePeerRecord(buf, expectedPeer)
                                                        -

                                                      delete

                                                      delete

                                                      • delete(peerId): Promise<void>

                                                      • Delete all data stored for the passed peer

                                                        Parameters

                                                        Returns Promise<void>

                                                        Example

                                                        await peerStore.addressBook.set(peerId, multiaddrs)
                                                        await peerStore.addressBook.get(peerId)
                                                        // multiaddrs[]

                                                        await peerStore.delete(peerId)

                                                        await peerStore.addressBook.get(peerId)
                                                        // []
                                                        -

                                                      forEach

                                                      forEach

                                                      • forEach(fn, query?): Promise<void>

                                                      • Loop over every peer - the looping is async because we read from a datastore but the peer operation is sync, this is to prevent long-lived peer operations causing deadlocks over the datastore which can happen if they try to access the peer store during the loop

                                                        Parameters

                                                        • fn: ((peer) => void)
                                                            • (peer): void

                                                            • Parameters

                                                              Returns void

                                                        • Optional query: PeerQuery

                                                        Returns Promise<void>

                                                        Example

                                                        await peerStore.forEach(peer => {
                                                          // ...
                                                        })
                                                        -

                                                      get

                                                      get

                                                      has

                                                      has

                                                      merge

                                                      merge

                                                      patch

                                                      patch

                                                      save

                                                      save

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      allconsumePeerRecorddeleteforEachgethasmergepatchsave
                                                      \ No newline at end of file +

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      allconsumePeerRecorddeleteforEachgethasmergepatchsave
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerStreamEvents.html b/interfaces/_libp2p_interface.PeerStreamEvents.html index 56125401df..d36b652be1 100644 --- a/interfaces/_libp2p_interface.PeerStreamEvents.html +++ b/interfaces/_libp2p_interface.PeerStreamEvents.html @@ -1,4 +1,4 @@ -PeerStreamEvents | libp2p

                                                      Interface PeerStreamEvents

                                                      interface PeerStreamEvents {
                                                          close: CustomEvent<never>;
                                                          stream:inbound: CustomEvent<never>;
                                                          stream:outbound: CustomEvent<never>;
                                                      }

                                                      Properties

                                                      close +PeerStreamEvents | libp2p

                                                      Interface PeerStreamEvents

                                                      interface PeerStreamEvents {
                                                          close: CustomEvent<never>;
                                                          stream:inbound: CustomEvent<never>;
                                                          stream:outbound: CustomEvent<never>;
                                                      }

                                                      Properties

                                                      close stream:inbound stream:outbound -

                                                      Properties

                                                      close

                                                      close: CustomEvent<never>

                                                      stream:inbound

                                                      stream:inbound: CustomEvent<never>

                                                      stream:outbound

                                                      stream:outbound: CustomEvent<never>

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      closestream:inboundstream:outbound
                                                      \ No newline at end of file +

                                                      Properties

                                                      close

                                                      close: CustomEvent<never>

                                                      stream:inbound

                                                      stream:inbound: CustomEvent<never>

                                                      stream:outbound

                                                      stream:outbound: CustomEvent<never>

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      closestream:inboundstream:outbound
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerStreams.html b/interfaces/_libp2p_interface.PeerStreams.html index 5536b4417d..0ed2789cda 100644 --- a/interfaces/_libp2p_interface.PeerStreams.html +++ b/interfaces/_libp2p_interface.PeerStreams.html @@ -3,7 +3,7 @@ https://github.com/microsoft/TypeScript/issues/43477 https://github.com/microsoft/TypeScript/issues/299 etc

                                                      -
                                                      interface PeerStreams {
                                                          id: PeerId;
                                                          inboundStream?: AsyncIterable<Uint8ArrayList>;
                                                          isWritable: boolean;
                                                          outboundStream?: Pushable<Uint8ArrayList, void, unknown>;
                                                          protocol: string;
                                                          addEventListener<K>(type, listener, options?): void;
                                                          attachInboundStream(stream): AsyncIterable<Uint8ArrayList>;
                                                          attachOutboundStream(stream): Promise<Pushable<Uint8ArrayList, void, unknown>>;
                                                          close(): void;
                                                          dispatchEvent(event): boolean;
                                                          dispatchEvent(event): boolean;
                                                          listenerCount(type): number;
                                                          removeEventListener<K>(type, listener?, options?): void;
                                                          removeEventListener(type, listener?, options?): void;
                                                          safeDispatchEvent<Detail>(type, detail): boolean;
                                                          write(buf): void;
                                                      }

                                                      Hierarchy (view full)

                                                      Properties

                                                      id +
                                                      interface PeerStreams {
                                                          id: PeerId;
                                                          inboundStream?: AsyncIterable<Uint8ArrayList>;
                                                          isWritable: boolean;
                                                          outboundStream?: Pushable<Uint8ArrayList, void, unknown>;
                                                          protocol: string;
                                                          addEventListener<K>(type, listener, options?): void;
                                                          attachInboundStream(stream): AsyncIterable<Uint8ArrayList>;
                                                          attachOutboundStream(stream): Promise<Pushable<Uint8ArrayList, void, unknown>>;
                                                          close(): void;
                                                          dispatchEvent(event): boolean;
                                                          dispatchEvent(event): boolean;
                                                          listenerCount(type): number;
                                                          removeEventListener<K>(type, listener?, options?): void;
                                                          removeEventListener(type, listener?, options?): void;
                                                          safeDispatchEvent<Detail>(type, detail): boolean;
                                                          write(buf): void;
                                                      }

                                                      Hierarchy (view full)

                                                      Properties

                                                      id inboundStream? isWritable outboundStream? @@ -17,8 +17,8 @@ removeEventListener safeDispatchEvent write -

                                                      Properties

                                                      id

                                                      id: PeerId

                                                      Optional inboundStream

                                                      inboundStream?: AsyncIterable<Uint8ArrayList>

                                                      isWritable

                                                      isWritable: boolean

                                                      Optional outboundStream

                                                      outboundStream?: Pushable<Uint8ArrayList, void, unknown>

                                                      protocol

                                                      protocol: string

                                                      Methods

                                                      addEventListener

                                                      attachInboundStream

                                                      attachOutboundStream

                                                      close

                                                      dispatchEvent

                                                      • dispatchEvent(event): boolean

                                                      • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                        +

                                                      Properties

                                                      id

                                                      id: PeerId

                                                      Optional inboundStream

                                                      inboundStream?: AsyncIterable<Uint8ArrayList>

                                                      isWritable

                                                      isWritable: boolean

                                                      Optional outboundStream

                                                      outboundStream?: Pushable<Uint8ArrayList, void, unknown>

                                                      protocol

                                                      protocol: string

                                                      Methods

                                                      addEventListener

                                                      attachInboundStream

                                                      attachOutboundStream

                                                      close

                                                      dispatchEvent

                                                      • dispatchEvent(event): boolean

                                                      • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                        MDN Reference

                                                        Parameters

                                                        Returns boolean

                                                      • dispatchEvent(event): boolean

                                                      • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                        MDN Reference

                                                        -

                                                        Parameters

                                                        Returns boolean

                                                      listenerCount

                                                      removeEventListener

                                                      safeDispatchEvent

                                                      write

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      idinboundStreamisWritableoutboundStreamprotocoladdEventListenerattachInboundStreamattachOutboundStreamclosedispatchEventlistenerCountremoveEventListenersafeDispatchEventwrite
                                                      \ No newline at end of file +

                                                      Parameters

                                                      Returns boolean

                                                      listenerCount

                                                      removeEventListener

                                                      safeDispatchEvent

                                                      write

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      idinboundStreamisWritableoutboundStreamprotocoladdEventListenerattachInboundStreamattachOutboundStreamclosedispatchEventlistenerCountremoveEventListenersafeDispatchEventwrite
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerUpdate.html b/interfaces/_libp2p_interface.PeerUpdate.html index 59798139a2..e40a280c2b 100644 --- a/interfaces/_libp2p_interface.PeerUpdate.html +++ b/interfaces/_libp2p_interface.PeerUpdate.html @@ -1,4 +1,4 @@ PeerUpdate | libp2p

                                                      Interface PeerUpdate

                                                      Event detail emitted when peer data changes

                                                      -
                                                      interface PeerUpdate {
                                                          peer: Peer;
                                                          previous?: Peer;
                                                      }

                                                      Properties

                                                      peer +
                                                      interface PeerUpdate {
                                                          peer: Peer;
                                                          previous?: Peer;
                                                      }

                                                      Properties

                                                      peer previous? -

                                                      Properties

                                                      peer

                                                      peer: Peer

                                                      Optional previous

                                                      previous?: Peer

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      peerprevious
                                                      \ No newline at end of file +

                                                      Properties

                                                      peer

                                                      peer: Peer

                                                      Optional previous

                                                      previous?: Peer

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      peerprevious
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PendingDial.html b/interfaces/_libp2p_interface.PendingDial.html index 7277eb588c..552739a223 100644 --- a/interfaces/_libp2p_interface.PendingDial.html +++ b/interfaces/_libp2p_interface.PendingDial.html @@ -1,12 +1,12 @@ PendingDial | libp2p

                                                      Interface PendingDial

                                                      An item in the dial queue

                                                      -
                                                      interface PendingDial {
                                                          id: string;
                                                          multiaddrs: Multiaddr[];
                                                          peerId?: PeerId;
                                                          status: PendingDialStatus;
                                                      }

                                                      Properties

                                                      id +
                                                      interface PendingDial {
                                                          id: string;
                                                          multiaddrs: Multiaddr[];
                                                          peerId?: PeerId;
                                                          status: PendingDialStatus;
                                                      }

                                                      Properties

                                                      id multiaddrs peerId? status

                                                      Properties

                                                      id

                                                      id: string

                                                      A unique identifier for this dial

                                                      -

                                                      multiaddrs

                                                      multiaddrs: Multiaddr[]

                                                      The list of multiaddrs that will be dialled. The returned connection will +

                                                      multiaddrs

                                                      multiaddrs: Multiaddr[]

                                                      The list of multiaddrs that will be dialled. The returned connection will use the first address that succeeds, all other dials part of this pending dial will be cancelled.

                                                      -

                                                      Optional peerId

                                                      peerId?: PeerId

                                                      If known, this is the peer id that libp2p expects to be dialling

                                                      -

                                                      status

                                                      status: PendingDialStatus

                                                      The current status of the dial

                                                      -

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      idmultiaddrspeerIdstatus
                                                      \ No newline at end of file +

                                                      Optional peerId

                                                      peerId?: PeerId

                                                      If known, this is the peer id that libp2p expects to be dialling

                                                      +

                                                      status

                                                      status: PendingDialStatus

                                                      The current status of the dial

                                                      +

                                                      Settings

                                                      Member Visibility

                                                      Theme

                                                      On This Page

                                                      idmultiaddrspeerIdstatus
                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PubSub.html b/interfaces/_libp2p_interface.PubSub.html index 5d3d8dc206..84902a9dce 100644 --- a/interfaces/_libp2p_interface.PubSub.html +++ b/interfaces/_libp2p_interface.PubSub.html @@ -3,7 +3,7 @@ https://github.com/microsoft/TypeScript/issues/43477 https://github.com/microsoft/TypeScript/issues/299 etc

                                                      -
                                                      interface PubSub<Events> {
                                                          globalSignaturePolicy: "StrictSign" | "StrictNoSign";
                                                          multicodecs: string[];
                                                          topicValidators: Map<string, TopicValidatorFn>;
                                                          addEventListener<K>(type, listener, options?): void;
                                                          dispatchEvent(event): boolean;
                                                          dispatchEvent(event): boolean;
                                                          getPeers(): PeerId[];
                                                          getSubscribers(topic): PeerId[];
                                                          getTopics(): string[];
                                                          listenerCount(type): number;
                                                          publish(topic, data): Promise<PublishResult>;
                                                          removeEventListener<K>(type, listener?, options?): void;
                                                          removeEventListener(type, listener?, options?): void;
                                                          safeDispatchEvent<Detail>(type, detail): boolean;
                                                          subscribe(topic): void;
                                                          unsubscribe(topic): void;
                                                      }

                                                      Type Parameters

                                                      Hierarchy (view full)

                                                      Implemented by

                                                      Properties

                                                      globalSignaturePolicy +
                                                      interface PubSub<Events> {
                                                          globalSignaturePolicy: "StrictSign" | "StrictNoSign";
                                                          multicodecs: string[];
                                                          topicValidators: Map<string, TopicValidatorFn>;
                                                          addEventListener<K>(type, listener, options?): void;
                                                          dispatchEvent(event): boolean;
                                                          dispatchEvent(event): boolean;
                                                          getPeers(): PeerId[];
                                                          getSubscribers(topic): PeerId[];
                                                          getTopics(): string[];
                                                          listenerCount(type): number;
                                                          publish(topic, data): Promise<PublishResult>;
                                                          removeEventListener<K>(type, listener?, options?): void;
                                                          removeEventListener(type, listener?, options?): void;
                                                          safeDispatchEvent<Detail>(type, detail): boolean;
                                                          subscribe(topic): void;
                                                          unsubscribe(topic): void;
                                                      }

                                                      Type Parameters

                                                      Hierarchy (view full)

                                                      Implemented by

                                                        Properties

                                                        globalSignaturePolicy multicodecs topicValidators

                                                        Methods

                                                        addEventListener @@ -21,29 +21,29 @@ signed or unsigned messages.

                                                        Signed messages prevent spoofing message senders and should be preferred to using unsigned messages.

                                                        -

                                                        multicodecs

                                                        multicodecs: string[]

                                                        A list of multicodecs that contain the pubsub protocol name.

                                                        -

                                                        topicValidators

                                                        topicValidators: Map<string, TopicValidatorFn>

                                                        Pubsub routers support message validators per topic, which will validate the message +

                                                        multicodecs

                                                        multicodecs: string[]

                                                        A list of multicodecs that contain the pubsub protocol name.

                                                        +

                                                        topicValidators

                                                        topicValidators: Map<string, TopicValidatorFn>

                                                        Pubsub routers support message validators per topic, which will validate the message before its propagations. They are stored in a map where keys are the topic name and values are the validators.

                                                        Example

                                                        const topic = 'topic'
                                                        const validateMessage = (msgTopic, msg) => {
                                                          const input = uint8ArrayToString(msg.data)
                                                          const validInputs = ['a', 'b', 'c']

                                                          if (!validInputs.includes(input)) {
                                                            throw new Error('no valid input received')
                                                          }
                                                        }
                                                        libp2p.pubsub.topicValidators.set(topic, validateMessage)
                                                        -

                                                        Methods

                                                        addEventListener

                                                        dispatchEvent

                                                        • dispatchEvent(event): boolean

                                                        • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                          +

                                                        Methods

                                                        addEventListener

                                                        dispatchEvent

                                                        • dispatchEvent(event): boolean

                                                        • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                          MDN Reference

                                                          Parameters

                                                          Returns boolean

                                                        • dispatchEvent(event): boolean

                                                        • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                          MDN Reference

                                                          -

                                                          Parameters

                                                          Returns boolean

                                                        getPeers

                                                        getSubscribers

                                                        • getSubscribers(topic): PeerId[]

                                                        • Gets a list of the PeerIds that are subscribed to one topic.

                                                          +

                                                          Parameters

                                                          Returns boolean

                                                        getPeers

                                                        getSubscribers

                                                        getTopics

                                                        getTopics

                                                        listenerCount

                                                        publish

                                                        listenerCount

                                                        publish

                                                        removeEventListener

                                                        safeDispatchEvent

                                                        subscribe

                                                        removeEventListener

                                                        safeDispatchEvent

                                                        subscribe

                                                        • subscribe(topic): void

                                                        • Subscribes to a pubsub topic.

                                                          Parameters

                                                          • topic: string

                                                          Returns void

                                                          Example

                                                          const topic = 'topic'
                                                          const handler = (msg) => {
                                                            if (msg.topic === topic) {
                                                              // msg.data - pubsub data received
                                                            }
                                                          }

                                                          libp2p.pubsub.addEventListener('message', handler)
                                                          libp2p.pubsub.subscribe(topic)
                                                          -

                                                        unsubscribe

                                                        unsubscribe

                                                        • unsubscribe(topic): void

                                                        • Unsubscribes from a pubsub topic.

                                                          Parameters

                                                          • topic: string

                                                          Returns void

                                                          Example

                                                          const topic = 'topic'
                                                          const handler = (msg) => {
                                                            // msg.data - pubsub data received
                                                          }

                                                          libp2p.pubsub.removeEventListener(topic handler)
                                                          libp2p.pubsub.unsubscribe(topic)
                                                          -

                                                        Settings

                                                        Member Visibility

                                                        Theme

                                                        On This Page

                                                        globalSignaturePolicymulticodecstopicValidatorsaddEventListenerdispatchEventgetPeersgetSubscribersgetTopicslistenerCountpublishremoveEventListenersafeDispatchEventsubscribeunsubscribe
                                                        \ No newline at end of file +

                                                        Settings

                                                        Member Visibility

                                                        Theme

                                                        On This Page

                                                        globalSignaturePolicymulticodecstopicValidatorsaddEventListenerdispatchEventgetPeersgetSubscribersgetTopicslistenerCountpublishremoveEventListenersafeDispatchEventsubscribeunsubscribe
                                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PubSubEvents.html b/interfaces/_libp2p_interface.PubSubEvents.html index 64dcc1688c..bcb920f9b7 100644 --- a/interfaces/_libp2p_interface.PubSubEvents.html +++ b/interfaces/_libp2p_interface.PubSubEvents.html @@ -1,3 +1,3 @@ -PubSubEvents | libp2p

                                                        Interface PubSubEvents

                                                        interface PubSubEvents {
                                                            message: CustomEvent<Message>;
                                                            subscription-change: CustomEvent<SubscriptionChangeData>;
                                                        }

                                                        Properties

                                                        message +PubSubEvents | libp2p

                                                        Interface PubSubEvents

                                                        interface PubSubEvents {
                                                            message: CustomEvent<Message>;
                                                            subscription-change: CustomEvent<SubscriptionChangeData>;
                                                        }

                                                        Properties

                                                        message subscription-change -

                                                        Properties

                                                        message

                                                        message: CustomEvent<Message>

                                                        subscription-change

                                                        subscription-change: CustomEvent<SubscriptionChangeData>

                                                        Settings

                                                        Member Visibility

                                                        Theme

                                                        On This Page

                                                        messagesubscription-change
                                                        \ No newline at end of file +

                                                        Properties

                                                        message

                                                        message: CustomEvent<Message>

                                                        subscription-change

                                                        subscription-change: CustomEvent<SubscriptionChangeData>

                                                        Settings

                                                        Member Visibility

                                                        Theme

                                                        On This Page

                                                        messagesubscription-change
                                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PubSubInit.html b/interfaces/_libp2p_interface.PubSubInit.html index fcb86206f2..cb7a5cbc75 100644 --- a/interfaces/_libp2p_interface.PubSubInit.html +++ b/interfaces/_libp2p_interface.PubSubInit.html @@ -1,4 +1,4 @@ -PubSubInit | libp2p

                                                        Interface PubSubInit

                                                        interface PubSubInit {
                                                            canRelayMessage?: boolean;
                                                            emitSelf?: boolean;
                                                            enabled?: boolean;
                                                            globalSignaturePolicy?: SignaturePolicy;
                                                            maxInboundStreams?: number;
                                                            maxOutboundStreams?: number;
                                                            messageProcessingConcurrency?: number;
                                                            multicodecs?: string[];
                                                        }

                                                        Hierarchy

                                                        • PubSubInit

                                                          Properties

                                                          canRelayMessage? +PubSubInit | libp2p

                                                          Interface PubSubInit

                                                          interface PubSubInit {
                                                              canRelayMessage?: boolean;
                                                              emitSelf?: boolean;
                                                              enabled?: boolean;
                                                              globalSignaturePolicy?: SignaturePolicy;
                                                              maxInboundStreams?: number;
                                                              maxOutboundStreams?: number;
                                                              messageProcessingConcurrency?: number;
                                                              multicodecs?: string[];
                                                          }

                                                          Hierarchy

                                                          • PubSubInit

                                                            Properties

                                                            canRelayMessage? emitSelf? enabled? globalSignaturePolicy? @@ -7,9 +7,9 @@ messageProcessingConcurrency? multicodecs?

                                                            Properties

                                                            Optional canRelayMessage

                                                            canRelayMessage?: boolean

                                                            if can relay messages not subscribed

                                                            -

                                                            Optional emitSelf

                                                            emitSelf?: boolean

                                                            if publish should emit to self, if subscribed

                                                            -

                                                            Optional enabled

                                                            enabled?: boolean

                                                            Optional globalSignaturePolicy

                                                            globalSignaturePolicy?: SignaturePolicy

                                                            defines how signatures should be handled

                                                            -

                                                            Optional maxInboundStreams

                                                            maxInboundStreams?: number

                                                            How many parallel incoming streams to allow on the pubsub protocol per-connection

                                                            -

                                                            Optional maxOutboundStreams

                                                            maxOutboundStreams?: number

                                                            How many parallel outgoing streams to allow on the pubsub protocol per-connection

                                                            -

                                                            Optional messageProcessingConcurrency

                                                            messageProcessingConcurrency?: number

                                                            handle this many incoming pubsub messages concurrently

                                                            -

                                                            Optional multicodecs

                                                            multicodecs?: string[]

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            canRelayMessageemitSelfenabledglobalSignaturePolicymaxInboundStreamsmaxOutboundStreamsmessageProcessingConcurrencymulticodecs
                                                            \ No newline at end of file +

                                                            Optional emitSelf

                                                            emitSelf?: boolean

                                                            if publish should emit to self, if subscribed

                                                            +

                                                            Optional enabled

                                                            enabled?: boolean

                                                            Optional globalSignaturePolicy

                                                            globalSignaturePolicy?: SignaturePolicy

                                                            defines how signatures should be handled

                                                            +

                                                            Optional maxInboundStreams

                                                            maxInboundStreams?: number

                                                            How many parallel incoming streams to allow on the pubsub protocol per-connection

                                                            +

                                                            Optional maxOutboundStreams

                                                            maxOutboundStreams?: number

                                                            How many parallel outgoing streams to allow on the pubsub protocol per-connection

                                                            +

                                                            Optional messageProcessingConcurrency

                                                            messageProcessingConcurrency?: number

                                                            handle this many incoming pubsub messages concurrently

                                                            +

                                                            Optional multicodecs

                                                            multicodecs?: string[]

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            canRelayMessageemitSelfenabledglobalSignaturePolicymaxInboundStreamsmaxOutboundStreamsmessageProcessingConcurrencymulticodecs
                                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PubSubRPC.html b/interfaces/_libp2p_interface.PubSubRPC.html index 126741f538..5a5cd74a1d 100644 --- a/interfaces/_libp2p_interface.PubSubRPC.html +++ b/interfaces/_libp2p_interface.PubSubRPC.html @@ -1,3 +1,3 @@ -PubSubRPC | libp2p

                                                            Interface PubSubRPC

                                                            interface PubSubRPC {
                                                                messages: PubSubRPCMessage[];
                                                                subscriptions: PubSubRPCSubscription[];
                                                            }

                                                            Properties

                                                            messages +PubSubRPC | libp2p

                                                            Interface PubSubRPC

                                                            interface PubSubRPC {
                                                                messages: PubSubRPCMessage[];
                                                                subscriptions: PubSubRPCSubscription[];
                                                            }

                                                            Properties

                                                            messages subscriptions -

                                                            Properties

                                                            messages

                                                            messages: PubSubRPCMessage[]

                                                            subscriptions

                                                            subscriptions: PubSubRPCSubscription[]

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            messagessubscriptions
                                                            \ No newline at end of file +

                                                            Properties

                                                            messages

                                                            messages: PubSubRPCMessage[]

                                                            subscriptions

                                                            subscriptions: PubSubRPCSubscription[]

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            messagessubscriptions
                                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PubSubRPCMessage.html b/interfaces/_libp2p_interface.PubSubRPCMessage.html index 6353dd64c4..28aab63da1 100644 --- a/interfaces/_libp2p_interface.PubSubRPCMessage.html +++ b/interfaces/_libp2p_interface.PubSubRPCMessage.html @@ -1,7 +1,7 @@ -PubSubRPCMessage | libp2p

                                                            Interface PubSubRPCMessage

                                                            interface PubSubRPCMessage {
                                                                data?: Uint8Array;
                                                                from?: Uint8Array;
                                                                key?: Uint8Array;
                                                                sequenceNumber?: Uint8Array;
                                                                signature?: Uint8Array;
                                                                topic?: string;
                                                            }

                                                            Properties

                                                            data? +PubSubRPCMessage | libp2p

                                                            Interface PubSubRPCMessage

                                                            interface PubSubRPCMessage {
                                                                data?: Uint8Array;
                                                                from?: Uint8Array;
                                                                key?: Uint8Array;
                                                                sequenceNumber?: Uint8Array;
                                                                signature?: Uint8Array;
                                                                topic?: string;
                                                            }

                                                            Properties

                                                            data? from? key? sequenceNumber? signature? topic? -

                                                            Properties

                                                            Optional data

                                                            data?: Uint8Array

                                                            Optional from

                                                            from?: Uint8Array

                                                            Optional key

                                                            key?: Uint8Array

                                                            Optional sequenceNumber

                                                            sequenceNumber?: Uint8Array

                                                            Optional signature

                                                            signature?: Uint8Array

                                                            Optional topic

                                                            topic?: string

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            datafromkeysequenceNumbersignaturetopic
                                                            \ No newline at end of file +

                                                            Properties

                                                            Optional data

                                                            data?: Uint8Array

                                                            Optional from

                                                            from?: Uint8Array

                                                            Optional key

                                                            key?: Uint8Array

                                                            Optional sequenceNumber

                                                            sequenceNumber?: Uint8Array

                                                            Optional signature

                                                            signature?: Uint8Array

                                                            Optional topic

                                                            topic?: string

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            datafromkeysequenceNumbersignaturetopic
                                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PubSubRPCSubscription.html b/interfaces/_libp2p_interface.PubSubRPCSubscription.html index 6e9dd7fe1f..d05581bbb5 100644 --- a/interfaces/_libp2p_interface.PubSubRPCSubscription.html +++ b/interfaces/_libp2p_interface.PubSubRPCSubscription.html @@ -1,3 +1,3 @@ -PubSubRPCSubscription | libp2p

                                                            Interface PubSubRPCSubscription

                                                            interface PubSubRPCSubscription {
                                                                subscribe?: boolean;
                                                                topic?: string;
                                                            }

                                                            Properties

                                                            subscribe? +PubSubRPCSubscription | libp2p

                                                            Interface PubSubRPCSubscription

                                                            interface PubSubRPCSubscription {
                                                                subscribe?: boolean;
                                                                topic?: string;
                                                            }

                                                            Properties

                                                            subscribe? topic? -

                                                            Properties

                                                            Optional subscribe

                                                            subscribe?: boolean

                                                            Optional topic

                                                            topic?: string

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            subscribetopic
                                                            \ No newline at end of file +

                                                            Properties

                                                            Optional subscribe

                                                            subscribe?: boolean

                                                            Optional topic

                                                            topic?: string

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            subscribetopic
                                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PublishResult.html b/interfaces/_libp2p_interface.PublishResult.html index bf09163552..91b0c96bcb 100644 --- a/interfaces/_libp2p_interface.PublishResult.html +++ b/interfaces/_libp2p_interface.PublishResult.html @@ -1,2 +1,2 @@ -PublishResult | libp2p

                                                            Interface PublishResult

                                                            interface PublishResult {
                                                                recipients: PeerId[];
                                                            }

                                                            Properties

                                                            recipients -

                                                            Properties

                                                            recipients

                                                            recipients: PeerId[]

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            recipients
                                                            \ No newline at end of file +PublishResult | libp2p

                                                            Interface PublishResult

                                                            interface PublishResult {
                                                                recipients: PeerId[];
                                                            }

                                                            Properties

                                                            recipients +

                                                            Properties

                                                            recipients

                                                            recipients: PeerId[]

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            recipients
                                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.RSAPeerId.html b/interfaces/_libp2p_interface.RSAPeerId.html index 11281cdd2d..3e57cf8ca2 100644 --- a/interfaces/_libp2p_interface.RSAPeerId.html +++ b/interfaces/_libp2p_interface.RSAPeerId.html @@ -4,7 +4,7 @@ secp256k1 should be preferred as they can embed their public key in the PeerId itself.

                                                            Deprecated

                                                            Ed25519 or secp256k1 keys are preferred to RSA

                                                            -
                                                            interface RSAPeerId {
                                                                publicKey?: RSAPublicKey;
                                                                type: "RSA";
                                                                equals(other?): boolean;
                                                                toCID(): CID<Uint8Array, 114, 18, 1>;
                                                                toMultihash(): MultihashDigest<18>;
                                                                toString(): string;
                                                            }

                                                            Properties

                                                            publicKey? +
                                                            interface RSAPeerId {
                                                                publicKey?: RSAPublicKey;
                                                                type: "RSA";
                                                                equals(other?): boolean;
                                                                toCID(): CID<Uint8Array, 114, 18, 1>;
                                                                toMultihash(): MultihashDigest<18>;
                                                                toString(): string;
                                                            }

                                                            Properties

                                                            publicKey? type

                                                            Methods

                                                            equals toCID @@ -14,10 +14,10 @@ refer to peers, so this will only be defined if the public key has previously been found through a routing query or during normal protocol operations

                                                            -

                                                            Readonly type

                                                            type: "RSA"

                                                            Methods

                                                            equals

                                                            toCID

                                                            Readonly type

                                                            type: "RSA"

                                                            Methods

                                                            equals

                                                            toCID

                                                            toMultihash

                                                            toMultihash

                                                            toString

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            publicKeytypeequalstoCIDtoMultihashtoString
                                                            \ No newline at end of file +

                                                            Returns MultihashDigest<18>

                                                            toString

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            publicKeytypeequalstoCIDtoMultihashtoString
                                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.RSAPrivateKey.html b/interfaces/_libp2p_interface.RSAPrivateKey.html index 687fa85b11..98067a9257 100644 --- a/interfaces/_libp2p_interface.RSAPrivateKey.html +++ b/interfaces/_libp2p_interface.RSAPrivateKey.html @@ -1,13 +1,13 @@ RSAPrivateKey | libp2p

                                                            Interface RSAPrivateKey

                                                            Generic private key interface

                                                            -
                                                            interface RSAPrivateKey {
                                                                publicKey: RSAPublicKey;
                                                                raw: Uint8Array;
                                                                type: "RSA";
                                                                equals(key?): boolean;
                                                                sign(data): Uint8Array | Promise<Uint8Array>;
                                                            }

                                                            Properties

                                                            publicKey +
                                                            interface RSAPrivateKey {
                                                                publicKey: RSAPublicKey;
                                                                raw: Uint8Array;
                                                                type: "RSA";
                                                                equals(key?): boolean;
                                                                sign(data): Uint8Array | Promise<Uint8Array>;
                                                            }

                                                            Properties

                                                            publicKey raw type

                                                            Methods

                                                            equals sign

                                                            Properties

                                                            Readonly publicKey

                                                            publicKey: RSAPublicKey

                                                            The public key that corresponds to this private key

                                                            -

                                                            Readonly raw

                                                            raw: Uint8Array

                                                            PKIX in ASN1 DER format

                                                            -

                                                            Readonly type

                                                            type: "RSA"

                                                            The type of this key

                                                            -

                                                            Methods

                                                            equals

                                                            sign

                                                            Readonly raw

                                                            raw: Uint8Array

                                                            PKIX in ASN1 DER format

                                                            +

                                                            Readonly type

                                                            type: "RSA"

                                                            The type of this key

                                                            +

                                                            Methods

                                                            equals

                                                            sign

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            publicKeyrawtypeequalssign
                                                            \ No newline at end of file +

                                                            Parameters

                                                            Returns Uint8Array | Promise<Uint8Array>

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            publicKeyrawtypeequalssign
                                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.RSAPublicKey.html b/interfaces/_libp2p_interface.RSAPublicKey.html index c7357443eb..68cb3f88f5 100644 --- a/interfaces/_libp2p_interface.RSAPublicKey.html +++ b/interfaces/_libp2p_interface.RSAPublicKey.html @@ -1,4 +1,4 @@ -RSAPublicKey | libp2p

                                                            Interface RSAPublicKey

                                                            interface RSAPublicKey {
                                                                raw: Uint8Array;
                                                                type: "RSA";
                                                                equals(key?): boolean;
                                                                toCID(): CID<unknown, 114, 18, 1>;
                                                                toMultihash(): MultihashDigest<18>;
                                                                toString(): string;
                                                                verify(data, sig): boolean | Promise<boolean>;
                                                            }

                                                            Properties

                                                            raw +RSAPublicKey | libp2p

                                                            Interface RSAPublicKey

                                                            interface RSAPublicKey {
                                                                raw: Uint8Array;
                                                                type: "RSA";
                                                                equals(key?): boolean;
                                                                toCID(): CID<unknown, 114, 18, 1>;
                                                                toMultihash(): MultihashDigest<18>;
                                                                toString(): string;
                                                                verify(data, sig): boolean | Promise<boolean>;
                                                            }

                                                            Properties

                                                            raw type

                                                            Methods

                                                            equals toCID @@ -6,14 +6,14 @@ toString verify

                                                            Properties

                                                            Readonly raw

                                                            raw: Uint8Array

                                                            PKIX in ASN1 DER format

                                                            -

                                                            Readonly type

                                                            type: "RSA"

                                                            The type of this key

                                                            -

                                                            Methods

                                                            equals

                                                            toCID

                                                            Readonly type

                                                            type: "RSA"

                                                            The type of this key

                                                            +

                                                            Methods

                                                            equals

                                                            toCID

                                                            • toCID(): CID<unknown, 114, 18, 1>

                                                            • Return this public key as a CID encoded with the libp2p-key codec

                                                              The digest contains a sha256 hash of the protobuf version of the public key.

                                                              -

                                                              Returns CID<unknown, 114, 18, 1>

                                                            toMultihash

                                                            toMultihash

                                                            toString

                                                            verify

                                                            toString

                                                            verify

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            rawtypeequalstoCIDtoMultihashtoStringverify
                                                            \ No newline at end of file +

                                                            Parameters

                                                            Returns boolean | Promise<boolean>

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            rawtypeequalstoCIDtoMultihashtoStringverify
                                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Record.html b/interfaces/_libp2p_interface.Record.html index 91439f6b28..dc0c736565 100644 --- a/interfaces/_libp2p_interface.Record.html +++ b/interfaces/_libp2p_interface.Record.html @@ -1,10 +1,10 @@ Record | libp2p

                                                            Interface Record

                                                            Record is the base implementation of a record that can be used as the payload of a libp2p envelope.

                                                            -
                                                            interface Record {
                                                                codec: Uint8Array;
                                                                domain: string;
                                                                equals(other): boolean;
                                                                marshal(): Uint8Array;
                                                            }

                                                            Properties

                                                            codec +
                                                            interface Record {
                                                                codec: Uint8Array;
                                                                domain: string;
                                                                equals(other): boolean;
                                                                marshal(): Uint8Array;
                                                            }

                                                            Properties

                                                            codec domain

                                                            Methods

                                                            equals marshal

                                                            Properties

                                                            codec

                                                            codec: Uint8Array

                                                            identifier of the type of record

                                                            -

                                                            domain

                                                            domain: string

                                                            signature domain.

                                                            -

                                                            Methods

                                                            equals

                                                            marshal

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            codecdomainequalsmarshal
                                                            \ No newline at end of file +

                                                            domain

                                                            domain: string

                                                            signature domain.

                                                            +

                                                            Methods

                                                            equals

                                                            marshal

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            codecdomainequalsmarshal
                                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.RoutingOptions.html b/interfaces/_libp2p_interface.RoutingOptions.html index 1843db51cf..23f6b50268 100644 --- a/interfaces/_libp2p_interface.RoutingOptions.html +++ b/interfaces/_libp2p_interface.RoutingOptions.html @@ -2,15 +2,15 @@ controlling where the values are read from. By default libp2p will check local caches but may not use the network if a valid local value is found, these options allow tuning that behaviour.

                                                            -
                                                            interface RoutingOptions {
                                                                onProgress?: ((evt) => void);
                                                                signal?: AbortSignal;
                                                                trace?: any;
                                                                useCache?: boolean;
                                                                useNetwork?: boolean;
                                                            }

                                                            Hierarchy (view full)

                                                            Properties

                                                            onProgress? +
                                                            interface RoutingOptions {
                                                                onProgress?: ((evt) => void);
                                                                signal?: AbortSignal;
                                                                trace?: any;
                                                                useCache?: boolean;
                                                                useNetwork?: boolean;
                                                            }

                                                            Hierarchy (view full)

                                                            Properties

                                                            onProgress? signal? trace? useCache? useNetwork? -

                                                            Properties

                                                            Optional onProgress

                                                            onProgress?: ((evt) => void)

                                                            Type declaration

                                                              • (evt): void

                                                              • Parameters

                                                                • evt: any

                                                                Returns void

                                                            Optional signal

                                                            signal?: AbortSignal

                                                            Optional trace

                                                            trace?: any

                                                            Optional useCache

                                                            useCache?: boolean

                                                            Pass false to not use cached values

                                                            +

                                                            Properties

                                                            Optional onProgress

                                                            onProgress?: ((evt) => void)

                                                            Type declaration

                                                              • (evt): void

                                                              • Parameters

                                                                • evt: any

                                                                Returns void

                                                            Optional signal

                                                            signal?: AbortSignal

                                                            Optional trace

                                                            trace?: any

                                                            Optional useCache

                                                            useCache?: boolean

                                                            Pass false to not use cached values

                                                            Default

                                                            true
                                                            -

                                                            Optional useNetwork

                                                            useNetwork?: boolean

                                                            Pass false to not use the network

                                                            +

                                                            Optional useNetwork

                                                            useNetwork?: boolean

                                                            Pass false to not use the network

                                                            Default

                                                            true
                                                            -

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            onProgresssignaltraceuseCacheuseNetwork
                                                            \ No newline at end of file +

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            onProgresssignaltraceuseCacheuseNetwork
                                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Secp256k1PeerId.html b/interfaces/_libp2p_interface.Secp256k1PeerId.html index 94ca616b1f..4b49f8239f 100644 --- a/interfaces/_libp2p_interface.Secp256k1PeerId.html +++ b/interfaces/_libp2p_interface.Secp256k1PeerId.html @@ -1,4 +1,4 @@ -Secp256k1PeerId | libp2p

                                                            Interface Secp256k1PeerId

                                                            interface Secp256k1PeerId {
                                                                publicKey: Secp256k1PublicKey;
                                                                type: "secp256k1";
                                                                equals(other?): boolean;
                                                                toCID(): CID<Uint8Array, 114, 0, 1>;
                                                                toMultihash(): MultihashDigest<0>;
                                                                toString(): string;
                                                            }

                                                            Properties

                                                            publicKey +Secp256k1PeerId | libp2p

                                                            Interface Secp256k1PeerId

                                                            interface Secp256k1PeerId {
                                                                publicKey: Secp256k1PublicKey;
                                                                type: "secp256k1";
                                                                equals(other?): boolean;
                                                                toCID(): CID<Uint8Array, 114, 0, 1>;
                                                                toMultihash(): MultihashDigest<0>;
                                                                toString(): string;
                                                            }

                                                            Properties

                                                            publicKey type

                                                            Methods

                                                            equals toCID @@ -6,10 +6,10 @@ toString

                                                            Properties

                                                            Readonly publicKey

                                                            publicKey: Secp256k1PublicKey

                                                            This will always be defined as the public key is embedded in the multihash of this PeerId

                                                            -

                                                            Readonly type

                                                            type: "secp256k1"

                                                            Methods

                                                            equals

                                                            toCID

                                                            Readonly type

                                                            type: "secp256k1"

                                                            Methods

                                                            equals

                                                            toCID

                                                            toMultihash

                                                            toMultihash

                                                            toString

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            publicKeytypeequalstoCIDtoMultihashtoString
                                                            \ No newline at end of file +

                                                            Returns MultihashDigest<0>

                                                            toString

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            publicKeytypeequalstoCIDtoMultihashtoString
                                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Secp256k1PrivateKey.html b/interfaces/_libp2p_interface.Secp256k1PrivateKey.html index bee21d8a73..cbcc0923cb 100644 --- a/interfaces/_libp2p_interface.Secp256k1PrivateKey.html +++ b/interfaces/_libp2p_interface.Secp256k1PrivateKey.html @@ -1,12 +1,12 @@ -Secp256k1PrivateKey | libp2p

                                                            Interface Secp256k1PrivateKey

                                                            interface Secp256k1PrivateKey {
                                                                publicKey: Secp256k1PublicKey;
                                                                raw: Uint8Array;
                                                                type: "secp256k1";
                                                                equals(key?): boolean;
                                                                sign(data): Uint8Array | Promise<Uint8Array>;
                                                            }

                                                            Properties

                                                            publicKey +Secp256k1PrivateKey | libp2p

                                                            Interface Secp256k1PrivateKey

                                                            interface Secp256k1PrivateKey {
                                                                publicKey: Secp256k1PublicKey;
                                                                raw: Uint8Array;
                                                                type: "secp256k1";
                                                                equals(key?): boolean;
                                                                sign(data): Uint8Array | Promise<Uint8Array>;
                                                            }

                                                            Properties

                                                            publicKey raw type

                                                            Methods

                                                            equals sign

                                                            Properties

                                                            Readonly publicKey

                                                            publicKey: Secp256k1PublicKey

                                                            The public key that corresponds to this private key

                                                            -

                                                            Readonly raw

                                                            raw: Uint8Array

                                                            The raw public key bytes

                                                            -

                                                            Readonly type

                                                            type: "secp256k1"

                                                            The type of this key

                                                            -

                                                            Methods

                                                            equals

                                                            sign

                                                            Readonly raw

                                                            raw: Uint8Array

                                                            The raw public key bytes

                                                            +

                                                            Readonly type

                                                            type: "secp256k1"

                                                            The type of this key

                                                            +

                                                            Methods

                                                            equals

                                                            sign

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            publicKeyrawtypeequalssign
                                                            \ No newline at end of file +

                                                            Parameters

                                                            Returns Uint8Array | Promise<Uint8Array>

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            publicKeyrawtypeequalssign
                                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Secp256k1PublicKey.html b/interfaces/_libp2p_interface.Secp256k1PublicKey.html index a69209e55d..658e54f6e2 100644 --- a/interfaces/_libp2p_interface.Secp256k1PublicKey.html +++ b/interfaces/_libp2p_interface.Secp256k1PublicKey.html @@ -1,4 +1,4 @@ -Secp256k1PublicKey | libp2p

                                                            Interface Secp256k1PublicKey

                                                            interface Secp256k1PublicKey {
                                                                raw: Uint8Array;
                                                                type: "secp256k1";
                                                                equals(key?): boolean;
                                                                toCID(): CID<unknown, 114, 0, 1>;
                                                                toMultihash(): MultihashDigest<0>;
                                                                toString(): string;
                                                                verify(data, sig): boolean | Promise<boolean>;
                                                            }

                                                            Properties

                                                            raw +Secp256k1PublicKey | libp2p

                                                            Interface Secp256k1PublicKey

                                                            interface Secp256k1PublicKey {
                                                                raw: Uint8Array;
                                                                type: "secp256k1";
                                                                equals(key?): boolean;
                                                                toCID(): CID<unknown, 114, 0, 1>;
                                                                toMultihash(): MultihashDigest<0>;
                                                                toString(): string;
                                                                verify(data, sig): boolean | Promise<boolean>;
                                                            }

                                                            Properties

                                                            raw type

                                                            Methods

                                                            equals toCID @@ -6,14 +6,14 @@ toString verify

                                                            Properties

                                                            Readonly raw

                                                            raw: Uint8Array

                                                            The raw public key bytes

                                                            -

                                                            Readonly type

                                                            type: "secp256k1"

                                                            The type of this key

                                                            -

                                                            Methods

                                                            equals

                                                            toCID

                                                            Readonly type

                                                            type: "secp256k1"

                                                            The type of this key

                                                            +

                                                            Methods

                                                            equals

                                                            toCID

                                                            • toCID(): CID<unknown, 114, 0, 1>

                                                            • Return this public key as a CID encoded with the libp2p-key codec

                                                              The digest contains an identity hash containing the protobuf wrapped version of the public key.

                                                              -

                                                              Returns CID<unknown, 114, 0, 1>

                                                            toMultihash

                                                            toMultihash

                                                            toString

                                                            verify

                                                            toString

                                                            verify

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            rawtypeequalstoCIDtoMultihashtoStringverify
                                                            \ No newline at end of file +

                                                            Parameters

                                                            Returns boolean | Promise<boolean>

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            rawtypeequalstoCIDtoMultihashtoStringverify
                                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.SecureConnectionOptions.html b/interfaces/_libp2p_interface.SecureConnectionOptions.html index 80b7969fcc..32b0a91eed 100644 --- a/interfaces/_libp2p_interface.SecureConnectionOptions.html +++ b/interfaces/_libp2p_interface.SecureConnectionOptions.html @@ -1,6 +1,6 @@ SecureConnectionOptions | libp2p

                                                            Interface SecureConnectionOptions

                                                            If the remote PeerId is known and passed as an option, the securing operation will throw if the remote peer cannot prove it has the private key that corresponds to the public key the remote PeerId is derived from.

                                                            -
                                                            interface SecureConnectionOptions {
                                                                remotePeer?: PeerId;
                                                                signal?: AbortSignal;
                                                            }

                                                            Hierarchy (view full)

                                                            Properties

                                                            remotePeer? +
                                                            interface SecureConnectionOptions {
                                                                remotePeer?: PeerId;
                                                                signal?: AbortSignal;
                                                            }

                                                            Hierarchy (view full)

                                                            Properties

                                                            remotePeer? signal? -

                                                            Properties

                                                            Optional remotePeer

                                                            remotePeer?: PeerId

                                                            Optional signal

                                                            signal?: AbortSignal

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            remotePeersignal
                                                            \ No newline at end of file +

                                                            Properties

                                                            Optional remotePeer

                                                            remotePeer?: PeerId

                                                            Optional signal

                                                            signal?: AbortSignal

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            remotePeersignal
                                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.SecuredConnection.html b/interfaces/_libp2p_interface.SecuredConnection.html index a5009527d3..e572cade37 100644 --- a/interfaces/_libp2p_interface.SecuredConnection.html +++ b/interfaces/_libp2p_interface.SecuredConnection.html @@ -1,4 +1,4 @@ -SecuredConnection | libp2p

                                                            Interface SecuredConnection<Stream, Extension>

                                                            interface SecuredConnection<Stream, Extension> {
                                                                conn: Stream;
                                                                remoteExtensions?: Extension;
                                                                remotePeer: PeerId;
                                                            }

                                                            Type Parameters

                                                            • Stream = any
                                                            • Extension = unknown

                                                            Properties

                                                            conn +SecuredConnection | libp2p

                                                            Interface SecuredConnection<Stream, Extension>

                                                            interface SecuredConnection<Stream, Extension> {
                                                                conn: Stream;
                                                                remoteExtensions?: Extension;
                                                                remotePeer: PeerId;
                                                            }

                                                            Type Parameters

                                                            • Stream = any
                                                            • Extension = unknown

                                                            Properties

                                                            conn remoteExtensions? remotePeer -

                                                            Properties

                                                            conn

                                                            conn: Stream

                                                            Optional remoteExtensions

                                                            remoteExtensions?: Extension

                                                            remotePeer

                                                            remotePeer: PeerId

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            connremoteExtensionsremotePeer
                                                            \ No newline at end of file +

                                                            Properties

                                                            conn

                                                            conn: Stream

                                                            Optional remoteExtensions

                                                            remoteExtensions?: Extension

                                                            remotePeer

                                                            remotePeer: PeerId

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            connremoteExtensionsremotePeer
                                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.SignedMessage.html b/interfaces/_libp2p_interface.SignedMessage.html index ac7632dfde..c91cebebc2 100644 --- a/interfaces/_libp2p_interface.SignedMessage.html +++ b/interfaces/_libp2p_interface.SignedMessage.html @@ -1,8 +1,8 @@ -SignedMessage | libp2p

                                                            Interface SignedMessage

                                                            interface SignedMessage {
                                                                data: Uint8Array;
                                                                from: PeerId;
                                                                key: PublicKey;
                                                                sequenceNumber: bigint;
                                                                signature: Uint8Array;
                                                                topic: string;
                                                                type: "signed";
                                                            }

                                                            Properties

                                                            data +SignedMessage | libp2p

                                                            Interface SignedMessage

                                                            interface SignedMessage {
                                                                data: Uint8Array;
                                                                from: PeerId;
                                                                key: PublicKey;
                                                                sequenceNumber: bigint;
                                                                signature: Uint8Array;
                                                                topic: string;
                                                                type: "signed";
                                                            }

                                                            Properties

                                                            data from key sequenceNumber signature topic type -

                                                            Properties

                                                            data

                                                            data: Uint8Array

                                                            from

                                                            from: PeerId

                                                            key

                                                            key: PublicKey

                                                            sequenceNumber

                                                            sequenceNumber: bigint

                                                            signature

                                                            signature: Uint8Array

                                                            topic

                                                            topic: string

                                                            type

                                                            type: "signed"

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            datafromkeysequenceNumbersignaturetopictype
                                                            \ No newline at end of file +

                                                            Properties

                                                            data

                                                            data: Uint8Array

                                                            from

                                                            from: PeerId

                                                            key

                                                            key: PublicKey

                                                            sequenceNumber

                                                            sequenceNumber: bigint

                                                            signature

                                                            signature: Uint8Array

                                                            topic

                                                            topic: string

                                                            type

                                                            type: "signed"

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            datafromkeysequenceNumbersignaturetopictype
                                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.SignedPeerRecord.html b/interfaces/_libp2p_interface.SignedPeerRecord.html index 9165fdb710..db0831fdda 100644 --- a/interfaces/_libp2p_interface.SignedPeerRecord.html +++ b/interfaces/_libp2p_interface.SignedPeerRecord.html @@ -1,4 +1,4 @@ SignedPeerRecord | libp2p

                                                            Interface SignedPeerRecord

                                                            Peer data signed by the remote Peer's public key

                                                            -
                                                            interface SignedPeerRecord {
                                                                addresses: Multiaddr[];
                                                                seq: bigint;
                                                            }

                                                            Properties

                                                            addresses +
                                                            interface SignedPeerRecord {
                                                                addresses: Multiaddr[];
                                                                seq: bigint;
                                                            }

                                                            Properties

                                                            addresses seq -

                                                            Properties

                                                            addresses

                                                            addresses: Multiaddr[]

                                                            seq

                                                            seq: bigint

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            addressesseq
                                                            \ No newline at end of file +

                                                            Properties

                                                            addresses

                                                            addresses: Multiaddr[]

                                                            seq

                                                            seq: bigint

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            addressesseq
                                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Startable.html b/interfaces/_libp2p_interface.Startable.html index 7b61c9399a..c354112f27 100644 --- a/interfaces/_libp2p_interface.Startable.html +++ b/interfaces/_libp2p_interface.Startable.html @@ -1,5 +1,5 @@ Startable | libp2p

                                                            Interface Startable

                                                            Implemented by components that have a lifecycle

                                                            -
                                                            interface Startable {
                                                                afterStart?(): void | Promise<void>;
                                                                afterStop?(): void | Promise<void>;
                                                                beforeStart?(): void | Promise<void>;
                                                                beforeStop?(): void | Promise<void>;
                                                                start(): void | Promise<void>;
                                                                stop(): void | Promise<void>;
                                                            }

                                                            Hierarchy (view full)

                                                            Methods

                                                            afterStart? +
                                                            interface Startable {
                                                                afterStart?(): void | Promise<void>;
                                                                afterStop?(): void | Promise<void>;
                                                                beforeStart?(): void | Promise<void>;
                                                                beforeStop?(): void | Promise<void>;
                                                                start(): void | Promise<void>;
                                                                stop(): void | Promise<void>;
                                                            }

                                                            Hierarchy (view full)

                                                            Methods

                                                            afterStart? afterStop? beforeStart? beforeStop? @@ -7,14 +7,14 @@ stop

                                                            Methods

                                                            Optional afterStart

                                                            • afterStart(): void | Promise<void>

                                                            • If implemented, this method will be invoked after the start method.

                                                              All other components will have had their start method invoked before this method is called.

                                                              -

                                                              Returns void | Promise<void>

                                                            Optional afterStop

                                                            Optional afterStop

                                                            • afterStop(): void | Promise<void>

                                                            • If implemented, this method will be invoked after the stop method.

                                                              All other components will have had their stop method invoked before this method is called.

                                                              -

                                                              Returns void | Promise<void>

                                                            Optional beforeStart

                                                            Optional beforeStart

                                                            Optional beforeStop

                                                            Optional beforeStop

                                                            start

                                                            start

                                                            stop

                                                            stop

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            afterStartafterStopbeforeStartbeforeStopstartstop
                                                            \ No newline at end of file +

                                                            Returns void | Promise<void>

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            afterStartafterStopbeforeStartbeforeStopstartstop
                                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.StopTimer.html b/interfaces/_libp2p_interface.StopTimer.html index 60d9b1ab1c..ec17e008a4 100644 --- a/interfaces/_libp2p_interface.StopTimer.html +++ b/interfaces/_libp2p_interface.StopTimer.html @@ -1,3 +1,3 @@ StopTimer | libp2p

                                                            Interface StopTimer

                                                            Call this function to stop the timer returned from the .timer method on the metric

                                                            -
                                                            interface StopTimer (() => void)

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            \ No newline at end of file +
                                                            interface StopTimer (() => void)

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Stream.html b/interfaces/_libp2p_interface.Stream.html index 71d84cd08c..e525a6c623 100644 --- a/interfaces/_libp2p_interface.Stream.html +++ b/interfaces/_libp2p_interface.Stream.html @@ -2,7 +2,7 @@ can be written to and read from at both ends.

                                                            It may be encrypted and multiplexed depending on the configuration of the nodes.

                                                            -
                                                            interface Stream {
                                                                direction: Direction;
                                                                id: string;
                                                                log: Logger;
                                                                metadata: Record<string, any>;
                                                                protocol?: string;
                                                                readStatus: ReadStatus;
                                                                sink: Sink<Source<Uint8Array | Uint8ArrayList>, Promise<void>>;
                                                                source: AsyncGenerator<Uint8ArrayList, any, unknown>;
                                                                status: StreamStatus;
                                                                timeline: StreamTimeline;
                                                                writeStatus: WriteStatus;
                                                                abort(err): void;
                                                                close(options?): Promise<void>;
                                                                closeRead(options?): Promise<void>;
                                                                closeWrite(options?): Promise<void>;
                                                            }

                                                            Hierarchy

                                                            Implemented by

                                                            Properties

                                                            direction +
                                                            interface Stream {
                                                                direction: Direction;
                                                                id: string;
                                                                log: Logger;
                                                                metadata: Record<string, any>;
                                                                protocol?: string;
                                                                readStatus: ReadStatus;
                                                                sink: Sink<Source<Uint8Array | Uint8ArrayList>, Promise<void>>;
                                                                source: AsyncGenerator<Uint8ArrayList, any, unknown>;
                                                                status: StreamStatus;
                                                                timeline: StreamTimeline;
                                                                writeStatus: WriteStatus;
                                                                abort(err): void;
                                                                close(options?): Promise<void>;
                                                                closeRead(options?): Promise<void>;
                                                                closeWrite(options?): Promise<void>;
                                                            }

                                                            Hierarchy

                                                            Implemented by

                                                              Properties

                                                              direction id log metadata @@ -18,25 +18,25 @@ closeRead closeWrite

                                                              Properties

                                                              direction

                                                              direction: Direction

                                                              Outbound streams are opened by the local node, inbound streams are opened by the remote

                                                              -

                                                              id

                                                              id: string

                                                              Unique identifier for a stream. Identifiers are not unique across muxers.

                                                              -

                                                              log

                                                              log: Logger

                                                              The stream logger

                                                              -

                                                              metadata

                                                              metadata: Record<string, any>

                                                              User defined stream metadata

                                                              -

                                                              Optional protocol

                                                              protocol?: string

                                                              The protocol negotiated for this stream

                                                              -

                                                              readStatus

                                                              readStatus: ReadStatus

                                                              The current status of the readable end of the stream

                                                              -

                                                              sink

                                                              sink: Sink<Source<Uint8Array | Uint8ArrayList>, Promise<void>>

                                                              source

                                                              source: AsyncGenerator<Uint8ArrayList, any, unknown>

                                                              status

                                                              status: StreamStatus

                                                              The current status of the stream

                                                              -

                                                              timeline

                                                              timeline: StreamTimeline

                                                              Lifecycle times for the stream

                                                              -

                                                              writeStatus

                                                              writeStatus: WriteStatus

                                                              The current status of the writable end of the stream

                                                              -

                                                              Methods

                                                              abort

                                                              id

                                                              id: string

                                                              Unique identifier for a stream. Identifiers are not unique across muxers.

                                                              +

                                                              log

                                                              log: Logger

                                                              The stream logger

                                                              +

                                                              metadata

                                                              metadata: Record<string, any>

                                                              User defined stream metadata

                                                              +

                                                              Optional protocol

                                                              protocol?: string

                                                              The protocol negotiated for this stream

                                                              +

                                                              readStatus

                                                              readStatus: ReadStatus

                                                              The current status of the readable end of the stream

                                                              +

                                                              sink

                                                              sink: Sink<Source<Uint8Array | Uint8ArrayList>, Promise<void>>

                                                              source

                                                              source: AsyncGenerator<Uint8ArrayList, any, unknown>

                                                              status

                                                              status: StreamStatus

                                                              The current status of the stream

                                                              +

                                                              timeline

                                                              timeline: StreamTimeline

                                                              Lifecycle times for the stream

                                                              +

                                                              writeStatus

                                                              writeStatus: WriteStatus

                                                              The current status of the writable end of the stream

                                                              +

                                                              Methods

                                                              abort

                                                              • abort(err): void

                                                              • Closes the stream for reading and writing. This should be called when a local error has occurred.

                                                                Note, if called without an error any buffered data in the source can still be consumed and the stream will end normally.

                                                                This will cause a RESET message to be sent to the remote, unless the sink has already ended.

                                                                The sink will return and the source will throw.

                                                                -

                                                                Parameters

                                                                Returns void

                                                              close

                                                              close

                                                              • close(options?): Promise<void>

                                                              • Closes the stream for reading and writing.

                                                                Any buffered data in the source can still be consumed and the stream will end normally.

                                                                This will cause a CLOSE message to be sent to the remote, unless the sink has already ended.

                                                                The sink and the source will return normally.

                                                                -

                                                                Parameters

                                                                Returns Promise<void>

                                                              closeRead

                                                              closeRead

                                                              • closeRead(options?): Promise<void>

                                                              • Closes the stream for reading. If iterating over the source of this stream in a for await of loop, it will return (exit the loop) after any buffered data has been consumed.

                                                                This function is called automatically by the muxer when it receives a CLOSE message from the remote.

                                                                The source will return normally, the sink will continue to consume.

                                                                -

                                                                Parameters

                                                                Returns Promise<void>

                                                              closeWrite

                                                              closeWrite

                                                              • closeWrite(options?): Promise<void>

                                                              • Closes the stream for writing. If iterating over the source of this stream in a for await of loop, it will return (exit the loop) after any buffered data has been consumed.

                                                                The source will return normally, the sink will continue to consume.

                                                                -

                                                                Parameters

                                                                Returns Promise<void>

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              directionidlogmetadataprotocolreadStatussinksourcestatustimelinewriteStatusabortclosecloseReadcloseWrite
                                                              \ No newline at end of file +

                                                              Parameters

                                                              Returns Promise<void>

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              directionidlogmetadataprotocolreadStatussinksourcestatustimelinewriteStatusabortclosecloseReadcloseWrite
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.StreamHandler.html b/interfaces/_libp2p_interface.StreamHandler.html index b09e930918..a8013eea51 100644 --- a/interfaces/_libp2p_interface.StreamHandler.html +++ b/interfaces/_libp2p_interface.StreamHandler.html @@ -1 +1 @@ -StreamHandler | libp2p

                                                              Interface StreamHandler

                                                              interface StreamHandler ((data) => void)

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              \ No newline at end of file +StreamHandler | libp2p

                                                              Interface StreamHandler

                                                              interface StreamHandler ((data) => void)

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.StreamHandlerOptions.html b/interfaces/_libp2p_interface.StreamHandlerOptions.html index 553fb9c80a..5e8d5e4943 100644 --- a/interfaces/_libp2p_interface.StreamHandlerOptions.html +++ b/interfaces/_libp2p_interface.StreamHandlerOptions.html @@ -1,12 +1,12 @@ -StreamHandlerOptions | libp2p

                                                              Interface StreamHandlerOptions

                                                              interface StreamHandlerOptions {
                                                                  maxInboundStreams?: number;
                                                                  maxOutboundStreams?: number;
                                                                  runOnLimitedConnection?: boolean;
                                                              }

                                                              Properties

                                                              maxInboundStreams? +StreamHandlerOptions | libp2p

                                                              Interface StreamHandlerOptions

                                                              interface StreamHandlerOptions {
                                                                  maxInboundStreams?: number;
                                                                  maxOutboundStreams?: number;
                                                                  runOnLimitedConnection?: boolean;
                                                              }

                                                              Properties

                                                              maxInboundStreams? maxOutboundStreams? runOnLimitedConnection?

                                                              Properties

                                                              Optional maxInboundStreams

                                                              maxInboundStreams?: number

                                                              How many incoming streams can be open for this protocol at the same time on each connection

                                                              Default

                                                              32
                                                              -

                                                              Optional maxOutboundStreams

                                                              maxOutboundStreams?: number

                                                              How many outgoing streams can be open for this protocol at the same time on each connection

                                                              +

                                                              Optional maxOutboundStreams

                                                              maxOutboundStreams?: number

                                                              How many outgoing streams can be open for this protocol at the same time on each connection

                                                              Default

                                                              64
                                                              -

                                                              Optional runOnLimitedConnection

                                                              runOnLimitedConnection?: boolean

                                                              Opt-in to running over connections with limits on how much data can be +

                                                              Optional runOnLimitedConnection

                                                              runOnLimitedConnection?: boolean

                                                              Opt-in to running over connections with limits on how much data can be transferred or how long it can be open for.

                                                              -

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              maxInboundStreamsmaxOutboundStreamsrunOnLimitedConnection
                                                              \ No newline at end of file +

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              maxInboundStreamsmaxOutboundStreamsrunOnLimitedConnection
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.StreamHandlerRecord.html b/interfaces/_libp2p_interface.StreamHandlerRecord.html index 4a23d2683a..f0a7d6e9c8 100644 --- a/interfaces/_libp2p_interface.StreamHandlerRecord.html +++ b/interfaces/_libp2p_interface.StreamHandlerRecord.html @@ -1,3 +1,3 @@ -StreamHandlerRecord | libp2p

                                                              Interface StreamHandlerRecord

                                                              interface StreamHandlerRecord {
                                                                  handler: StreamHandler;
                                                                  options: StreamHandlerOptions;
                                                              }

                                                              Properties

                                                              handler +StreamHandlerRecord | libp2p

                                                              Interface StreamHandlerRecord

                                                              interface StreamHandlerRecord {
                                                                  handler: StreamHandler;
                                                                  options: StreamHandlerOptions;
                                                              }

                                                              Properties

                                                              handler options -

                                                              Properties

                                                              handler

                                                              handler: StreamHandler

                                                              options

                                                              options: StreamHandlerOptions

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              handleroptions
                                                              \ No newline at end of file +

                                                              Properties

                                                              handler

                                                              handler: StreamHandler

                                                              options

                                                              options: StreamHandlerOptions

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              handleroptions
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.StreamMuxer.html b/interfaces/_libp2p_interface.StreamMuxer.html index 0bb7c8cdce..aa100a420f 100644 --- a/interfaces/_libp2p_interface.StreamMuxer.html +++ b/interfaces/_libp2p_interface.StreamMuxer.html @@ -1,5 +1,5 @@ StreamMuxer | libp2p

                                                              Interface StreamMuxer

                                                              A libp2p stream muxer

                                                              -
                                                              interface StreamMuxer {
                                                                  protocol: string;
                                                                  sink: Sink<AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>, unknown>;
                                                                  source: AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>;
                                                                  streams: Stream[];
                                                                  abort(err): void;
                                                                  close(options?): Promise<void>;
                                                                  newStream(name?): Stream | Promise<Stream>;
                                                              }

                                                              Hierarchy

                                                              Properties

                                                              protocol +
                                                              interface StreamMuxer {
                                                                  protocol: string;
                                                                  sink: Sink<AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>, unknown>;
                                                                  source: AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>;
                                                                  streams: Stream[];
                                                                  abort(err): void;
                                                                  close(options?): Promise<void>;
                                                                  newStream(name?): Stream | Promise<Stream>;
                                                              }

                                                              Hierarchy

                                                              Properties

                                                              protocol sink source streams @@ -7,9 +7,9 @@ close newStream

                                                              Properties

                                                              protocol

                                                              protocol: string

                                                              The protocol used to select this muxer during connection opening

                                                              -

                                                              sink

                                                              sink: Sink<AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>, unknown>

                                                              source

                                                              source: AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>

                                                              Readonly streams

                                                              streams: Stream[]

                                                              A list of streams that are currently open. Closed streams will not be returned.

                                                              -

                                                              Methods

                                                              abort

                                                              close

                                                              newStream

                                                              sink

                                                              sink: Sink<AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>, unknown>

                                                              source

                                                              source: AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>

                                                              Readonly streams

                                                              streams: Stream[]

                                                              A list of streams that are currently open. Closed streams will not be returned.

                                                              +

                                                              Methods

                                                              abort

                                                              close

                                                              newStream

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              protocolsinksourcestreamsabortclosenewStream
                                                              \ No newline at end of file +

                                                              Parameters

                                                              Returns Stream | Promise<Stream>

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              protocolsinksourcestreamsabortclosenewStream
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.StreamMuxerFactory.html b/interfaces/_libp2p_interface.StreamMuxerFactory.html index f76c5d2a51..aa58c11af8 100644 --- a/interfaces/_libp2p_interface.StreamMuxerFactory.html +++ b/interfaces/_libp2p_interface.StreamMuxerFactory.html @@ -1,5 +1,5 @@ -StreamMuxerFactory | libp2p

                                                              Interface StreamMuxerFactory

                                                              interface StreamMuxerFactory {
                                                                  protocol: string;
                                                                  createStreamMuxer(init?): StreamMuxer;
                                                              }

                                                              Properties

                                                              protocol +StreamMuxerFactory | libp2p

                                                              Interface StreamMuxerFactory

                                                              interface StreamMuxerFactory {
                                                                  protocol: string;
                                                                  createStreamMuxer(init?): StreamMuxer;
                                                              }

                                                              Properties

                                                              protocol

                                                              Methods

                                                              createStreamMuxer

                                                              Properties

                                                              protocol

                                                              protocol: string

                                                              The protocol used to select this muxer during connection opening

                                                              -

                                                              Methods

                                                              createStreamMuxer

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              protocolcreateStreamMuxer
                                                              \ No newline at end of file +

                                                              Methods

                                                              createStreamMuxer

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              protocolcreateStreamMuxer
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.StreamMuxerInit.html b/interfaces/_libp2p_interface.StreamMuxerInit.html index 2cc3c8436d..9406c78874 100644 --- a/interfaces/_libp2p_interface.StreamMuxerInit.html +++ b/interfaces/_libp2p_interface.StreamMuxerInit.html @@ -1,7 +1,7 @@ -StreamMuxerInit | libp2p

                                                              Interface StreamMuxerInit

                                                              interface StreamMuxerInit {
                                                                  direction?: Direction;
                                                                  onIncomingStream?(stream): void;
                                                                  onStreamEnd?(stream): void;
                                                              }

                                                              Properties

                                                              direction? +StreamMuxerInit | libp2p

                                                              Interface StreamMuxerInit

                                                              interface StreamMuxerInit {
                                                                  direction?: Direction;
                                                                  onIncomingStream?(stream): void;
                                                                  onStreamEnd?(stream): void;
                                                              }

                                                              Properties

                                                              direction?

                                                              Methods

                                                              onIncomingStream? onStreamEnd?

                                                              Properties

                                                              Optional direction

                                                              direction?: Direction

                                                              Outbound stream muxers are opened by the local node, inbound stream muxers are opened by the remote

                                                              -

                                                              Methods

                                                              Optional onIncomingStream

                                                              Optional onStreamEnd

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              directiononIncomingStreamonStreamEnd
                                                              \ No newline at end of file +

                                                              Methods

                                                              Optional onIncomingStream

                                                              Optional onStreamEnd

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              directiononIncomingStreamonStreamEnd
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.StreamTimeline.html b/interfaces/_libp2p_interface.StreamTimeline.html index 804480e20b..1b91046dc1 100644 --- a/interfaces/_libp2p_interface.StreamTimeline.html +++ b/interfaces/_libp2p_interface.StreamTimeline.html @@ -1,13 +1,13 @@ -StreamTimeline | libp2p

                                                              Interface StreamTimeline

                                                              interface StreamTimeline {
                                                                  abort?: number;
                                                                  close?: number;
                                                                  closeRead?: number;
                                                                  closeWrite?: number;
                                                                  open: number;
                                                                  reset?: number;
                                                              }

                                                              Properties

                                                              abort? +StreamTimeline | libp2p

                                                              Interface StreamTimeline

                                                              interface StreamTimeline {
                                                                  abort?: number;
                                                                  close?: number;
                                                                  closeRead?: number;
                                                                  closeWrite?: number;
                                                                  open: number;
                                                                  reset?: number;
                                                              }

                                                              Properties

                                                              abort? close? closeRead? closeWrite? open reset?

                                                              Properties

                                                              Optional abort

                                                              abort?: number

                                                              A timestamp of when the stream was aborted

                                                              -

                                                              Optional close

                                                              close?: number

                                                              A timestamp of when the stream was closed for both reading and writing

                                                              -

                                                              Optional closeRead

                                                              closeRead?: number

                                                              A timestamp of when the stream was closed for reading

                                                              -

                                                              Optional closeWrite

                                                              closeWrite?: number

                                                              A timestamp of when the stream was closed for writing

                                                              -

                                                              open

                                                              open: number

                                                              A timestamp of when the stream was opened

                                                              -

                                                              Optional reset

                                                              reset?: number

                                                              A timestamp of when the stream was reset

                                                              -

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              abortclosecloseReadcloseWriteopenreset
                                                              \ No newline at end of file +

                                                              Optional close

                                                              close?: number

                                                              A timestamp of when the stream was closed for both reading and writing

                                                              +

                                                              Optional closeRead

                                                              closeRead?: number

                                                              A timestamp of when the stream was closed for reading

                                                              +

                                                              Optional closeWrite

                                                              closeWrite?: number

                                                              A timestamp of when the stream was closed for writing

                                                              +

                                                              open

                                                              open: number

                                                              A timestamp of when the stream was opened

                                                              +

                                                              Optional reset

                                                              reset?: number

                                                              A timestamp of when the stream was reset

                                                              +

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              abortclosecloseReadcloseWriteopenreset
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Subscription.html b/interfaces/_libp2p_interface.Subscription.html index eaa488ff49..b0be5aefca 100644 --- a/interfaces/_libp2p_interface.Subscription.html +++ b/interfaces/_libp2p_interface.Subscription.html @@ -1,3 +1,3 @@ -Subscription | libp2p

                                                              Interface Subscription

                                                              interface Subscription {
                                                                  subscribe: boolean;
                                                                  topic: string;
                                                              }

                                                              Properties

                                                              subscribe +Subscription | libp2p

                                                              Interface Subscription

                                                              interface Subscription {
                                                                  subscribe: boolean;
                                                                  topic: string;
                                                              }

                                                              Properties

                                                              subscribe topic -

                                                              Properties

                                                              subscribe

                                                              subscribe: boolean

                                                              topic

                                                              topic: string

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              subscribetopic
                                                              \ No newline at end of file +

                                                              Properties

                                                              subscribe

                                                              subscribe: boolean

                                                              topic

                                                              topic: string

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              subscribetopic
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.SubscriptionChangeData.html b/interfaces/_libp2p_interface.SubscriptionChangeData.html index a70b458020..3347e65ac4 100644 --- a/interfaces/_libp2p_interface.SubscriptionChangeData.html +++ b/interfaces/_libp2p_interface.SubscriptionChangeData.html @@ -1,3 +1,3 @@ -SubscriptionChangeData | libp2p

                                                              Interface SubscriptionChangeData

                                                              interface SubscriptionChangeData {
                                                                  peerId: PeerId;
                                                                  subscriptions: Subscription[];
                                                              }

                                                              Properties

                                                              peerId +SubscriptionChangeData | libp2p

                                                              Interface SubscriptionChangeData

                                                              interface SubscriptionChangeData {
                                                                  peerId: PeerId;
                                                                  subscriptions: Subscription[];
                                                              }

                                                              Properties

                                                              peerId subscriptions -

                                                              Properties

                                                              peerId

                                                              peerId: PeerId

                                                              subscriptions

                                                              subscriptions: Subscription[]

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              peerIdsubscriptions
                                                              \ No newline at end of file +

                                                              Properties

                                                              peerId

                                                              peerId: PeerId

                                                              subscriptions

                                                              subscriptions: Subscription[]

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              peerIdsubscriptions
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Summary.html b/interfaces/_libp2p_interface.Summary.html index 094c391072..44fdb9820f 100644 --- a/interfaces/_libp2p_interface.Summary.html +++ b/interfaces/_libp2p_interface.Summary.html @@ -1,10 +1,10 @@ Summary | libp2p

                                                              Interface Summary

                                                              A tracked summary loosely based on the Summary interface exposed by the prom-client module

                                                              -
                                                              interface Summary {
                                                                  observe(value): void;
                                                                  reset(): void;
                                                                  timer(): StopTimer;
                                                              }

                                                              Methods

                                                              observe +
                                                              interface Summary {
                                                                  observe(value): void;
                                                                  reset(): void;
                                                                  timer(): StopTimer;
                                                              }

                                                              Methods

                                                              observe reset timer

                                                              Methods

                                                              observe

                                                              reset

                                                              timer

                                                              reset

                                                              timer

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              observeresettimer
                                                              \ No newline at end of file +

                                                              Returns StopTimer

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              observeresettimer
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.SummaryGroup.html b/interfaces/_libp2p_interface.SummaryGroup.html index 373f8dd66f..bde5fb032d 100644 --- a/interfaces/_libp2p_interface.SummaryGroup.html +++ b/interfaces/_libp2p_interface.SummaryGroup.html @@ -1,11 +1,11 @@ SummaryGroup | libp2p

                                                              Interface SummaryGroup<T>

                                                              A group of tracked summaries loosely based on the Summary interface exposed by the prom-client module

                                                              -
                                                              interface SummaryGroup<T> {
                                                                  observe(values): void;
                                                                  reset(): void;
                                                                  timer(key): StopTimer;
                                                              }

                                                              Type Parameters

                                                              • T extends string = any

                                                              Methods

                                                              observe +
                                                              interface SummaryGroup<T> {
                                                                  observe(values): void;
                                                                  reset(): void;
                                                                  timer(key): StopTimer;
                                                              }

                                                              Type Parameters

                                                              • T extends string = any

                                                              Methods

                                                              observe reset timer

                                                              Methods

                                                              observe

                                                              reset

                                                              reset

                                                              timer

                                                              timer

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              observeresettimer
                                                              \ No newline at end of file +

                                                              Parameters

                                                              Returns StopTimer

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              observeresettimer
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.SummaryOptions.html b/interfaces/_libp2p_interface.SummaryOptions.html index 34a52be22c..b68986cff2 100644 --- a/interfaces/_libp2p_interface.SummaryOptions.html +++ b/interfaces/_libp2p_interface.SummaryOptions.html @@ -1,6 +1,6 @@ SummaryOptions | libp2p

                                                              Interface SummaryOptions

                                                              Create tracked metrics with these options. Loosely based on the interfaces exposed by the prom-client module

                                                              -
                                                              interface SummaryOptions {
                                                                  ageBuckets?: number;
                                                                  compressCount?: number;
                                                                  help?: string;
                                                                  label?: string;
                                                                  maxAgeSeconds?: number;
                                                                  percentiles?: number[];
                                                                  pruneAgedBuckets?: boolean;
                                                              }

                                                              Hierarchy (view full)

                                                              Properties

                                                              ageBuckets? +
                                                              interface SummaryOptions {
                                                                  ageBuckets?: number;
                                                                  compressCount?: number;
                                                                  help?: string;
                                                                  label?: string;
                                                                  maxAgeSeconds?: number;
                                                                  percentiles?: number[];
                                                                  pruneAgedBuckets?: boolean;
                                                              }

                                                              Hierarchy (view full)

                                                              Properties

                                                              ageBuckets? compressCount? help? label? @@ -8,10 +8,10 @@ percentiles? pruneAgedBuckets?

                                                              Properties

                                                              Optional ageBuckets

                                                              ageBuckets?: number

                                                              Configure how many buckets in the sliding window

                                                              -

                                                              Optional compressCount

                                                              compressCount?: number

                                                              Control compression of data in t-digest

                                                              -

                                                              Optional help

                                                              help?: string

                                                              Optional help for the metric

                                                              -

                                                              Optional label

                                                              label?: string

                                                              Optional label for the metric

                                                              -

                                                              Optional maxAgeSeconds

                                                              maxAgeSeconds?: number

                                                              Configure how old a bucket can be before it is reset for sliding window

                                                              -

                                                              Optional percentiles

                                                              percentiles?: number[]

                                                              Percentiles for the summary

                                                              -

                                                              Optional pruneAgedBuckets

                                                              pruneAgedBuckets?: boolean

                                                              Remove entries without any new values in the last maxAgeSeconds

                                                              -

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              ageBucketscompressCounthelplabelmaxAgeSecondspercentilespruneAgedBuckets
                                                              \ No newline at end of file +

                                                              Optional compressCount

                                                              compressCount?: number

                                                              Control compression of data in t-digest

                                                              +

                                                              Optional help

                                                              help?: string

                                                              Optional help for the metric

                                                              +

                                                              Optional label

                                                              label?: string

                                                              Optional label for the metric

                                                              +

                                                              Optional maxAgeSeconds

                                                              maxAgeSeconds?: number

                                                              Configure how old a bucket can be before it is reset for sliding window

                                                              +

                                                              Optional percentiles

                                                              percentiles?: number[]

                                                              Percentiles for the summary

                                                              +

                                                              Optional pruneAgedBuckets

                                                              pruneAgedBuckets?: boolean

                                                              Remove entries without any new values in the last maxAgeSeconds

                                                              +

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              ageBucketscompressCounthelplabelmaxAgeSecondspercentilespruneAgedBuckets
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.TLSCertificate.html b/interfaces/_libp2p_interface.TLSCertificate.html index a56c784b12..23822ebaa9 100644 --- a/interfaces/_libp2p_interface.TLSCertificate.html +++ b/interfaces/_libp2p_interface.TLSCertificate.html @@ -1,5 +1,5 @@ -TLSCertificate | libp2p

                                                              Interface TLSCertificate

                                                              interface TLSCertificate {
                                                                  cert: string;
                                                                  key: string;
                                                              }

                                                              Properties

                                                              cert +TLSCertificate | libp2p

                                                              Interface TLSCertificate

                                                              interface TLSCertificate {
                                                                  cert: string;
                                                                  key: string;
                                                              }

                                                              Properties

                                                              cert key

                                                              Properties

                                                              cert

                                                              cert: string

                                                              The certificate chain in PEM format

                                                              -

                                                              key

                                                              key: string

                                                              The private key that corresponds to the certificate in PEM format

                                                              -

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              certkey
                                                              \ No newline at end of file +

                                                              key

                                                              key: string

                                                              The private key that corresponds to the certificate in PEM format

                                                              +

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              certkey
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Tag.html b/interfaces/_libp2p_interface.Tag.html index 07493c4589..04381568a0 100644 --- a/interfaces/_libp2p_interface.Tag.html +++ b/interfaces/_libp2p_interface.Tag.html @@ -1,3 +1,3 @@ -Tag | libp2p

                                                              Interface Tag

                                                              interface Tag {
                                                                  value: number;
                                                              }

                                                              Properties

                                                              value +Tag | libp2p

                                                              Interface Tag

                                                              interface Tag {
                                                                  value: number;
                                                              }

                                                              Properties

                                                              value

                                                              Properties

                                                              value

                                                              value: number

                                                              The tag value

                                                              -

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              value
                                                              \ No newline at end of file +

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              value
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.TagOptions.html b/interfaces/_libp2p_interface.TagOptions.html index 63e613d155..6cd73802f8 100644 --- a/interfaces/_libp2p_interface.TagOptions.html +++ b/interfaces/_libp2p_interface.TagOptions.html @@ -1,5 +1,5 @@ -TagOptions | libp2p

                                                              Interface TagOptions

                                                              interface TagOptions {
                                                                  ttl?: number;
                                                                  value?: number;
                                                              }

                                                              Properties

                                                              ttl? +TagOptions | libp2p

                                                              Interface TagOptions

                                                              interface TagOptions {
                                                                  ttl?: number;
                                                                  value?: number;
                                                              }

                                                              Properties

                                                              ttl? value?

                                                              Properties

                                                              Optional ttl

                                                              ttl?: number

                                                              An optional duration in ms after which the tag will expire

                                                              -

                                                              Optional value

                                                              value?: number

                                                              An optional tag value (1-100)

                                                              -

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              ttlvalue
                                                              \ No newline at end of file +

                                                              Optional value

                                                              value?: number

                                                              An optional tag value (1-100)

                                                              +

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              ttlvalue
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.TopicValidatorFn.html b/interfaces/_libp2p_interface.TopicValidatorFn.html index eaa2979cb5..849b64a183 100644 --- a/interfaces/_libp2p_interface.TopicValidatorFn.html +++ b/interfaces/_libp2p_interface.TopicValidatorFn.html @@ -1 +1 @@ -TopicValidatorFn | libp2p

                                                              Interface TopicValidatorFn

                                                              interface TopicValidatorFn ((peer, message) => TopicValidatorResult | Promise<TopicValidatorResult>)

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              \ No newline at end of file +TopicValidatorFn | libp2p

                                                              Interface TopicValidatorFn

                                                              interface TopicValidatorFn ((peer, message) => TopicValidatorResult | Promise<TopicValidatorResult>)

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Topology.html b/interfaces/_libp2p_interface.Topology.html index cb3b6c8f2d..291ddde6a7 100644 --- a/interfaces/_libp2p_interface.Topology.html +++ b/interfaces/_libp2p_interface.Topology.html @@ -2,19 +2,19 @@ complete network.

                                                              It is a way to be notified when peers that support a given protocol connect to or disconnect from the current node.

                                                              -
                                                              interface Topology {
                                                                  filter?: TopologyFilter;
                                                                  notifyOnLimitedConnection?: boolean;
                                                                  onConnect?(peerId, conn): void;
                                                                  onDisconnect?(peerId): void;
                                                              }

                                                              Properties

                                                              filter? +
                                                              interface Topology {
                                                                  filter?: TopologyFilter;
                                                                  notifyOnLimitedConnection?: boolean;
                                                                  onConnect?(peerId, conn): void;
                                                                  onDisconnect?(peerId): void;
                                                              }

                                                              Properties

                                                              filter? notifyOnLimitedConnection?

                                                              Methods

                                                              onConnect? onDisconnect?

                                                              Properties

                                                              Optional filter

                                                              filter?: TopologyFilter

                                                              An optional filter can prevent duplicate topology notifications for the same peer.

                                                              -

                                                              Optional notifyOnLimitedConnection

                                                              notifyOnLimitedConnection?: boolean

                                                              If true, invoke onConnect for this topology on limited connections, e.g. +

                                                              Optional notifyOnLimitedConnection

                                                              notifyOnLimitedConnection?: boolean

                                                              If true, invoke onConnect for this topology on limited connections, e.g. ones with limits on how much data can be transferred or how long they can be open for.

                                                              Default

                                                              false
                                                              -

                                                              Methods

                                                              Optional onConnect

                                                              Methods

                                                              Optional onConnect

                                                              Optional onDisconnect

                                                              Optional onDisconnect

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              filternotifyOnLimitedConnectiononConnectonDisconnect
                                                              \ No newline at end of file +

                                                              Parameters

                                                              Returns void

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              filternotifyOnLimitedConnectiononConnectonDisconnect
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.TopologyFilter.html b/interfaces/_libp2p_interface.TopologyFilter.html index eec628fc19..3d4d0292a5 100644 --- a/interfaces/_libp2p_interface.TopologyFilter.html +++ b/interfaces/_libp2p_interface.TopologyFilter.html @@ -1,6 +1,6 @@ TopologyFilter | libp2p

                                                              Interface TopologyFilter

                                                              A topology filter

                                                              See

                                                              https://libp2p.github.io/js-libp2p/functions/_libp2p_peer_collections.peerFilter-1.html

                                                              -
                                                              interface TopologyFilter {
                                                                  add(peerId): void;
                                                                  has(peerId): boolean;
                                                                  remove(peerId): void;
                                                              }

                                                              Methods

                                                              add +
                                                              interface TopologyFilter {
                                                                  add(peerId): void;
                                                                  has(peerId): boolean;
                                                                  remove(peerId): void;
                                                              }

                                                              Methods

                                                              add has remove -

                                                              Methods

                                                              add

                                                              has

                                                              remove

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              addhasremove
                                                              \ No newline at end of file +

                                                              Methods

                                                              add

                                                              has

                                                              remove

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              addhasremove
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.TraceFunctionOptions.html b/interfaces/_libp2p_interface.TraceFunctionOptions.html index 07c58340f1..06ed528dcf 100644 --- a/interfaces/_libp2p_interface.TraceFunctionOptions.html +++ b/interfaces/_libp2p_interface.TraceFunctionOptions.html @@ -1,4 +1,4 @@ -TraceFunctionOptions | libp2p

                                                              Interface TraceFunctionOptions<A, B>

                                                              interface TraceFunctionOptions<A, B> {
                                                                  optionsIndex?: number;
                                                                  getAttributesFromArgs?(args, attributes): TraceAttributes;
                                                                  getAttributesFromReturnValue?(value, attributes): TraceAttributes;
                                                              }

                                                              Type Parameters

                                                              • A
                                                              • B

                                                              Hierarchy (view full)

                                                              Properties

                                                              optionsIndex? +TraceFunctionOptions | libp2p

                                                              Interface TraceFunctionOptions<A, B>

                                                              interface TraceFunctionOptions<A, B> {
                                                                  optionsIndex?: number;
                                                                  getAttributesFromArgs?(args, attributes): TraceAttributes;
                                                                  getAttributesFromReturnValue?(value, attributes): TraceAttributes;
                                                              }

                                                              Type Parameters

                                                              • A
                                                              • B

                                                              Hierarchy (view full)

                                                              Properties

                                                              optionsIndex?

                                                              Methods

                                                              getAttributesFromArgs? getAttributesFromReturnValue?

                                                              Properties

                                                              Optional optionsIndex

                                                              optionsIndex?: number

                                                              To construct a trace that spans multiple method invocations, it's necessary @@ -6,8 +6,8 @@

                                                              Specify the index of the options object in the args array here.

                                                              Default

                                                              0
                                                              -

                                                              Methods

                                                              Optional getAttributesFromArgs

                                                              Optional getAttributesFromReturnValue

                                                              Methods

                                                              Optional getAttributesFromArgs

                                                              Optional getAttributesFromReturnValue

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              optionsIndexgetAttributesFromArgsgetAttributesFromReturnValue
                                                              \ No newline at end of file +

                                                              Parameters

                                                              Returns TraceAttributes

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              optionsIndexgetAttributesFromArgsgetAttributesFromReturnValue
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.TraceGeneratorFunctionOptions.html b/interfaces/_libp2p_interface.TraceGeneratorFunctionOptions.html index 7bf504ccb7..d9275770fe 100644 --- a/interfaces/_libp2p_interface.TraceGeneratorFunctionOptions.html +++ b/interfaces/_libp2p_interface.TraceGeneratorFunctionOptions.html @@ -1,4 +1,4 @@ -TraceGeneratorFunctionOptions | libp2p

                                                              Interface TraceGeneratorFunctionOptions<A, B, C>

                                                              interface TraceGeneratorFunctionOptions<A, B, C> {
                                                                  optionsIndex?: number;
                                                                  getAttributesFromArgs?(args, attributes): TraceAttributes;
                                                                  getAttributesFromReturnValue?(value, attributes): TraceAttributes;
                                                                  getAttributesFromYieldedValue?(value, attributes, index): TraceAttributes;
                                                              }

                                                              Type Parameters

                                                              • A
                                                              • B
                                                              • C = any

                                                              Hierarchy (view full)

                                                              Properties

                                                              optionsIndex? +TraceGeneratorFunctionOptions | libp2p

                                                              Interface TraceGeneratorFunctionOptions<A, B, C>

                                                              interface TraceGeneratorFunctionOptions<A, B, C> {
                                                                  optionsIndex?: number;
                                                                  getAttributesFromArgs?(args, attributes): TraceAttributes;
                                                                  getAttributesFromReturnValue?(value, attributes): TraceAttributes;
                                                                  getAttributesFromYieldedValue?(value, attributes, index): TraceAttributes;
                                                              }

                                                              Type Parameters

                                                              • A
                                                              • B
                                                              • C = any

                                                              Hierarchy (view full)

                                                              Properties

                                                              optionsIndex?

                                                              Methods

                                                              getAttributesFromArgs? getAttributesFromReturnValue? getAttributesFromYieldedValue? @@ -7,11 +7,11 @@

                                                              Specify the index of the options object in the args array here.

                                                              Default

                                                              0
                                                              -

                                                              Methods

                                                              Optional getAttributesFromArgs

                                                              Optional getAttributesFromReturnValue

                                                              Methods

                                                              Optional getAttributesFromArgs

                                                              Optional getAttributesFromReturnValue

                                                              Optional getAttributesFromYieldedValue

                                                              Optional getAttributesFromYieldedValue

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              optionsIndexgetAttributesFromArgsgetAttributesFromReturnValuegetAttributesFromYieldedValue
                                                              \ No newline at end of file +

                                                              Parameters

                                                              Returns TraceAttributes

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              optionsIndexgetAttributesFromArgsgetAttributesFromReturnValuegetAttributesFromYieldedValue
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.TraceOptions.html b/interfaces/_libp2p_interface.TraceOptions.html index aa8427cd60..d306be2148 100644 --- a/interfaces/_libp2p_interface.TraceOptions.html +++ b/interfaces/_libp2p_interface.TraceOptions.html @@ -1,4 +1,4 @@ TraceOptions | libp2p

                                                              Interface TraceOptions

                                                              An object that includes a trace object that is passed onwards.

                                                              This is used by metrics method tracing to link function calls together.

                                                              -
                                                              interface TraceOptions {
                                                                  trace?: any;
                                                              }

                                                              Hierarchy (view full)

                                                              Properties

                                                              trace? -

                                                              Properties

                                                              Optional trace

                                                              trace?: any

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              trace
                                                              \ No newline at end of file +
                                                              interface TraceOptions {
                                                                  trace?: any;
                                                              }

                                                              Hierarchy (view full)

                                                              Properties

                                                              trace? +

                                                              Properties

                                                              Optional trace

                                                              trace?: any

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              trace
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Transport.html b/interfaces/_libp2p_interface.Transport.html index 0ee4862580..9bfeea5a51 100644 --- a/interfaces/_libp2p_interface.Transport.html +++ b/interfaces/_libp2p_interface.Transport.html @@ -1,16 +1,16 @@ Transport | libp2p

                                                              Interface Transport<DialEvents>

                                                              A libp2p transport offers dial and listen methods to establish connections.

                                                              -
                                                              interface Transport<DialEvents> {
                                                                  [toStringTag]: string;
                                                                  [transportSymbol]: true;
                                                                  dialFilter: MultiaddrFilter;
                                                                  listenFilter: MultiaddrFilter;
                                                                  createListener(options): Listener;
                                                                  dial(ma, options): Promise<Connection>;
                                                              }

                                                              Type Parameters

                                                              Properties

                                                              [toStringTag] +
                                                              interface Transport<DialEvents> {
                                                                  [toStringTag]: string;
                                                                  [transportSymbol]: true;
                                                                  dialFilter: MultiaddrFilter;
                                                                  listenFilter: MultiaddrFilter;
                                                                  createListener(options): Listener;
                                                                  dial(ma, options): Promise<Connection>;
                                                              }

                                                              Type Parameters

                                                              Properties

                                                              [toStringTag] [transportSymbol] dialFilter listenFilter

                                                              Methods

                                                              createListener dial

                                                              Properties

                                                              [toStringTag]

                                                              [toStringTag]: string

                                                              Used to identify the transport

                                                              -

                                                              [transportSymbol]

                                                              [transportSymbol]: true

                                                              Used by the isTransport function

                                                              -

                                                              dialFilter

                                                              dialFilter: MultiaddrFilter

                                                              Takes a list of Multiaddrs and returns only addresses that are vali for +

                                                              [transportSymbol]

                                                              [transportSymbol]: true

                                                              Used by the isTransport function

                                                              +

                                                              dialFilter

                                                              dialFilter: MultiaddrFilter

                                                              Takes a list of Multiaddrs and returns only addresses that are vali for the transport to dial

                                                              -

                                                              listenFilter

                                                              listenFilter: MultiaddrFilter

                                                              Takes a list of Multiaddrs and returns only addresses that are valid for +

                                                              listenFilter

                                                              listenFilter: MultiaddrFilter

                                                              Takes a list of Multiaddrs and returns only addresses that are valid for the transport to listen on

                                                              -

                                                              Methods

                                                              createListener

                                                              dial

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              [toStringTag][transportSymbol]dialFilterlistenFiltercreateListenerdial
                                                              \ No newline at end of file +

                                                              Methods

                                                              createListener

                                                              dial

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              [toStringTag][transportSymbol]dialFilterlistenFiltercreateListenerdial
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.TypedEventTarget.html b/interfaces/_libp2p_interface.TypedEventTarget.html index 0fb14dacca..a924ecb1c2 100644 --- a/interfaces/_libp2p_interface.TypedEventTarget.html +++ b/interfaces/_libp2p_interface.TypedEventTarget.html @@ -3,13 +3,13 @@ https://github.com/microsoft/TypeScript/issues/43477 https://github.com/microsoft/TypeScript/issues/299 etc

                                                              -
                                                              interface TypedEventTarget<EventMap> {
                                                                  addEventListener<K>(type, listener, options?): void;
                                                                  dispatchEvent(event): boolean;
                                                                  dispatchEvent(event): boolean;
                                                                  listenerCount(type): number;
                                                                  removeEventListener<K>(type, listener?, options?): void;
                                                                  removeEventListener(type, listener?, options?): void;
                                                                  safeDispatchEvent<Detail>(type, detail): boolean;
                                                              }

                                                              Type Parameters

                                                              Hierarchy (view full)

                                                              Implemented by

                                                              Methods

                                                              addEventListener +
                                                              interface TypedEventTarget<EventMap> {
                                                                  addEventListener<K>(type, listener, options?): void;
                                                                  dispatchEvent(event): boolean;
                                                                  dispatchEvent(event): boolean;
                                                                  listenerCount(type): number;
                                                                  removeEventListener<K>(type, listener?, options?): void;
                                                                  removeEventListener(type, listener?, options?): void;
                                                                  safeDispatchEvent<Detail>(type, detail): boolean;
                                                              }

                                                              Type Parameters

                                                              • EventMap extends Record<string, any>

                                                              Hierarchy (view full)

                                                              Implemented by

                                                              Methods

                                                              addEventListener dispatchEvent listenerCount removeEventListener safeDispatchEvent -

                                                              Methods

                                                              addEventListener

                                                              dispatchEvent

                                                              • dispatchEvent(event): boolean

                                                              • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                                +

                                                              Methods

                                                              addEventListener

                                                              dispatchEvent

                                                              • dispatchEvent(event): boolean

                                                              • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                                MDN Reference

                                                                Parameters

                                                                Returns boolean

                                                              • dispatchEvent(event): boolean

                                                              • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                                MDN Reference

                                                                -

                                                                Parameters

                                                                Returns boolean

                                                              listenerCount

                                                              removeEventListener

                                                              safeDispatchEvent

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              addEventListenerdispatchEventlistenerCountremoveEventListenersafeDispatchEvent
                                                              \ No newline at end of file +

                                                              Parameters

                                                              Returns boolean

                                                              listenerCount

                                                              removeEventListener

                                                              safeDispatchEvent

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              addEventListenerdispatchEventlistenerCountremoveEventListenersafeDispatchEvent
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.URLPeerId.html b/interfaces/_libp2p_interface.URLPeerId.html index 8c0b420c01..c004e6dde7 100644 --- a/interfaces/_libp2p_interface.URLPeerId.html +++ b/interfaces/_libp2p_interface.URLPeerId.html @@ -1,14 +1,14 @@ -URLPeerId | libp2p

                                                              Interface URLPeerId

                                                              interface URLPeerId {
                                                                  publicKey: undefined;
                                                                  type: "url";
                                                                  equals(other?): boolean;
                                                                  toCID(): CID<Uint8Array, 2336, 0, 1>;
                                                                  toMultihash(): MultihashDigest<0>;
                                                                  toString(): string;
                                                              }

                                                              Properties

                                                              publicKey +URLPeerId | libp2p

                                                              Interface URLPeerId

                                                              interface URLPeerId {
                                                                  publicKey: undefined;
                                                                  type: "url";
                                                                  equals(other?): boolean;
                                                                  toCID(): CID<Uint8Array, 2336, 0, 1>;
                                                                  toMultihash(): MultihashDigest<0>;
                                                                  toString(): string;
                                                              }

                                                              Properties

                                                              publicKey type

                                                              Methods

                                                              equals toCID toMultihash toString

                                                              Properties

                                                              Readonly publicKey

                                                              publicKey: undefined

                                                              This will always be undefined as URL Peers do not have public keys

                                                              -

                                                              Readonly type

                                                              type: "url"

                                                              Methods

                                                              equals

                                                              toCID

                                                              Readonly type

                                                              type: "url"

                                                              Methods

                                                              equals

                                                              toCID

                                                              toMultihash

                                                              toMultihash

                                                              toString

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              publicKeytypeequalstoCIDtoMultihashtoString
                                                              \ No newline at end of file +

                                                              Returns MultihashDigest<0>

                                                              toString

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              publicKeytypeequalstoCIDtoMultihashtoString
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.UnsignedMessage.html b/interfaces/_libp2p_interface.UnsignedMessage.html index 9f622bd4ee..51e4027b5d 100644 --- a/interfaces/_libp2p_interface.UnsignedMessage.html +++ b/interfaces/_libp2p_interface.UnsignedMessage.html @@ -1,4 +1,4 @@ -UnsignedMessage | libp2p

                                                              Interface UnsignedMessage

                                                              interface UnsignedMessage {
                                                                  data: Uint8Array;
                                                                  topic: string;
                                                                  type: "unsigned";
                                                              }

                                                              Properties

                                                              data +UnsignedMessage | libp2p

                                                              Interface UnsignedMessage

                                                              interface UnsignedMessage {
                                                                  data: Uint8Array;
                                                                  topic: string;
                                                                  type: "unsigned";
                                                              }

                                                              Properties

                                                              data topic type -

                                                              Properties

                                                              data

                                                              data: Uint8Array

                                                              topic

                                                              topic: string

                                                              type

                                                              type: "unsigned"

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              datatopictype
                                                              \ No newline at end of file +

                                                              Properties

                                                              data

                                                              data: Uint8Array

                                                              topic

                                                              topic: string

                                                              type

                                                              type: "unsigned"

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              datatopictype
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Upgrader.html b/interfaces/_libp2p_interface.Upgrader.html index 5a2dff23ea..b6b724cc92 100644 --- a/interfaces/_libp2p_interface.Upgrader.html +++ b/interfaces/_libp2p_interface.Upgrader.html @@ -1,6 +1,6 @@ -Upgrader | libp2p

                                                              Interface Upgrader

                                                              interface Upgrader {
                                                                  upgradeInbound(maConn, opts?): Promise<void>;
                                                                  upgradeOutbound(maConn, opts?): Promise<Connection>;
                                                              }

                                                              Methods

                                                              upgradeInbound +Upgrader | libp2p

                                                              Interface Upgrader

                                                              interface Upgrader {
                                                                  upgradeInbound(maConn, opts?): Promise<void>;
                                                                  upgradeOutbound(maConn, opts?): Promise<Connection>;
                                                              }

                                                              Methods

                                                              upgradeInbound upgradeOutbound

                                                              Methods

                                                              upgradeInbound

                                                              upgradeOutbound

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              upgradeInboundupgradeOutbound
                                                              \ No newline at end of file +

                                                              Parameters

                                                              Returns Promise<void>

                                                              upgradeOutbound

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              upgradeInboundupgradeOutbound
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface.UpgraderOptions.html b/interfaces/_libp2p_interface.UpgraderOptions.html index c3c74124d8..4bac7ed12a 100644 --- a/interfaces/_libp2p_interface.UpgraderOptions.html +++ b/interfaces/_libp2p_interface.UpgraderOptions.html @@ -2,10 +2,10 @@ the optional signal property.

                                                              Example

                                                              const controller = new AbortController()

                                                              aLongRunningOperation({
                                                                signal: controller.signal
                                                              })

                                                              // later

                                                              controller.abort()
                                                              -
                                                              interface UpgraderOptions<ConnectionUpgradeEvents> {
                                                                  limits?: ConnectionLimits;
                                                                  muxerFactory?: StreamMuxerFactory;
                                                                  onProgress?: ((evt) => void);
                                                                  signal?: AbortSignal;
                                                                  skipEncryption?: boolean;
                                                                  skipProtection?: boolean;
                                                              }

                                                              Type Parameters

                                                              Hierarchy (view full)

                                                              Properties

                                                              limits? +
                                                              interface UpgraderOptions<ConnectionUpgradeEvents> {
                                                                  limits?: ConnectionLimits;
                                                                  muxerFactory?: StreamMuxerFactory;
                                                                  onProgress?: ((evt) => void);
                                                                  signal?: AbortSignal;
                                                                  skipEncryption?: boolean;
                                                                  skipProtection?: boolean;
                                                              }

                                                              Type Parameters

                                                              Hierarchy (view full)

                                                              Properties

                                                              limits? muxerFactory? onProgress? signal? skipEncryption? skipProtection? -

                                                              Properties

                                                              Optional limits

                                                              limits?: ConnectionLimits

                                                              Optional muxerFactory

                                                              muxerFactory?: StreamMuxerFactory

                                                              Optional onProgress

                                                              onProgress?: ((evt) => void)

                                                              Type declaration

                                                              Optional signal

                                                              signal?: AbortSignal

                                                              Optional skipEncryption

                                                              skipEncryption?: boolean

                                                              Optional skipProtection

                                                              skipProtection?: boolean

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              limitsmuxerFactoryonProgresssignalskipEncryptionskipProtection
                                                              \ No newline at end of file +

                                                              Properties

                                                              Optional limits

                                                              limits?: ConnectionLimits

                                                              Optional muxerFactory

                                                              muxerFactory?: StreamMuxerFactory

                                                              Optional onProgress

                                                              onProgress?: ((evt) => void)

                                                              Type declaration

                                                              Optional signal

                                                              signal?: AbortSignal

                                                              Optional skipEncryption

                                                              skipEncryption?: boolean

                                                              Optional skipProtection

                                                              skipProtection?: boolean

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              limitsmuxerFactoryonProgresssignalskipEncryptionskipProtection
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_compliance_tests.connection_encryption.ConnectionEncrypterSetupArgs.html b/interfaces/_libp2p_interface_compliance_tests.connection_encryption.ConnectionEncrypterSetupArgs.html index 6f87bab38e..adbed599d5 100644 --- a/interfaces/_libp2p_interface_compliance_tests.connection_encryption.ConnectionEncrypterSetupArgs.html +++ b/interfaces/_libp2p_interface_compliance_tests.connection_encryption.ConnectionEncrypterSetupArgs.html @@ -1,2 +1,2 @@ -ConnectionEncrypterSetupArgs | libp2p

                                                              Interface ConnectionEncrypterSetupArgs

                                                              interface ConnectionEncrypterSetupArgs {
                                                                  privateKey: PrivateKey;
                                                              }

                                                              Properties

                                                              privateKey -

                                                              Properties

                                                              privateKey

                                                              privateKey: PrivateKey

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              privateKey
                                                              \ No newline at end of file +ConnectionEncrypterSetupArgs | libp2p

                                                              Interface ConnectionEncrypterSetupArgs

                                                              interface ConnectionEncrypterSetupArgs {
                                                                  privateKey: PrivateKey;
                                                              }

                                                              Properties

                                                              privateKey +

                                                              Properties

                                                              privateKey

                                                              privateKey: PrivateKey

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              privateKey
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_compliance_tests.index.TestSetup.html b/interfaces/_libp2p_interface_compliance_tests.index.TestSetup.html index a843712608..3173612260 100644 --- a/interfaces/_libp2p_interface_compliance_tests.index.TestSetup.html +++ b/interfaces/_libp2p_interface_compliance_tests.index.TestSetup.html @@ -1,3 +1,3 @@ -TestSetup | libp2p

                                                              Interface TestSetup<T, SetupArgs>

                                                              interface TestSetup<T, SetupArgs> {
                                                                  setup(args?): Promise<T>;
                                                                  teardown(): Promise<void>;
                                                              }

                                                              Type Parameters

                                                              • T
                                                              • SetupArgs = Record<string, unknown>

                                                              Methods

                                                              setup +TestSetup | libp2p

                                                              Interface TestSetup<T, SetupArgs>

                                                              interface TestSetup<T, SetupArgs> {
                                                                  setup(args?): Promise<T>;
                                                                  teardown(): Promise<void>;
                                                              }

                                                              Type Parameters

                                                              • T
                                                              • SetupArgs = Record<string, unknown>

                                                              Methods

                                                              setup teardown -

                                                              Methods

                                                              setup

                                                              teardown

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              setupteardown
                                                              \ No newline at end of file +

                                                              Methods

                                                              setup

                                                              teardown

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              setupteardown
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_compliance_tests.mocks.MockConnectionManagerComponents.html b/interfaces/_libp2p_interface_compliance_tests.mocks.MockConnectionManagerComponents.html index b790acadb8..ec69c74929 100644 --- a/interfaces/_libp2p_interface_compliance_tests.mocks.MockConnectionManagerComponents.html +++ b/interfaces/_libp2p_interface_compliance_tests.mocks.MockConnectionManagerComponents.html @@ -1,4 +1,4 @@ -MockConnectionManagerComponents | libp2p

                                                              Interface MockConnectionManagerComponents

                                                              interface MockConnectionManagerComponents {
                                                                  events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                                  peerId: PeerId;
                                                                  registrar: Registrar;
                                                              }

                                                              Properties

                                                              events +MockConnectionManagerComponents | libp2p

                                                              Interface MockConnectionManagerComponents

                                                              interface MockConnectionManagerComponents {
                                                                  events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                                  peerId: PeerId;
                                                                  registrar: Registrar;
                                                              }

                                                              Properties

                                                              events peerId registrar -

                                                              Properties

                                                              events

                                                              events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                                              peerId

                                                              peerId: PeerId

                                                              registrar

                                                              registrar: Registrar

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              eventspeerIdregistrar
                                                              \ No newline at end of file +

                                                              Properties

                                                              events

                                                              events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                                              peerId

                                                              peerId: PeerId

                                                              registrar

                                                              registrar: Registrar

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              eventspeerIdregistrar
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_compliance_tests.mocks.MockConnectionOptions.html b/interfaces/_libp2p_interface_compliance_tests.mocks.MockConnectionOptions.html index 54d73cfb39..debfd845b3 100644 --- a/interfaces/_libp2p_interface_compliance_tests.mocks.MockConnectionOptions.html +++ b/interfaces/_libp2p_interface_compliance_tests.mocks.MockConnectionOptions.html @@ -1,5 +1,5 @@ -MockConnectionOptions | libp2p

                                                              Interface MockConnectionOptions

                                                              interface MockConnectionOptions {
                                                                  direction?: Direction;
                                                                  logger?: ComponentLogger;
                                                                  muxerFactory?: StreamMuxerFactory;
                                                                  registrar?: Registrar;
                                                              }

                                                              Properties

                                                              direction? +MockConnectionOptions | libp2p

                                                              Interface MockConnectionOptions

                                                              interface MockConnectionOptions {
                                                                  direction?: Direction;
                                                                  logger?: ComponentLogger;
                                                                  muxerFactory?: StreamMuxerFactory;
                                                                  registrar?: Registrar;
                                                              }

                                                              Properties

                                                              direction? logger? muxerFactory? registrar? -

                                                              Properties

                                                              Optional direction

                                                              direction?: Direction

                                                              Optional logger

                                                              logger?: ComponentLogger

                                                              Optional muxerFactory

                                                              muxerFactory?: StreamMuxerFactory

                                                              Optional registrar

                                                              registrar?: Registrar

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              directionloggermuxerFactoryregistrar
                                                              \ No newline at end of file +

                                                              Properties

                                                              Optional direction

                                                              direction?: Direction

                                                              Optional logger

                                                              logger?: ComponentLogger

                                                              Optional muxerFactory

                                                              muxerFactory?: StreamMuxerFactory

                                                              Optional registrar

                                                              registrar?: Registrar

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              directionloggermuxerFactoryregistrar
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_compliance_tests.mocks.MockMultiaddrConnPairOptions.html b/interfaces/_libp2p_interface_compliance_tests.mocks.MockMultiaddrConnPairOptions.html index d0855e4d4f..43ed60643d 100644 --- a/interfaces/_libp2p_interface_compliance_tests.mocks.MockMultiaddrConnPairOptions.html +++ b/interfaces/_libp2p_interface_compliance_tests.mocks.MockMultiaddrConnPairOptions.html @@ -1,3 +1,3 @@ -MockMultiaddrConnPairOptions | libp2p

                                                              Interface MockMultiaddrConnPairOptions

                                                              interface MockMultiaddrConnPairOptions {
                                                                  addrs: Multiaddr[];
                                                                  remotePeer: PeerId;
                                                              }

                                                              Properties

                                                              addrs +MockMultiaddrConnPairOptions | libp2p

                                                              Interface MockMultiaddrConnPairOptions

                                                              interface MockMultiaddrConnPairOptions {
                                                                  addrs: Multiaddr[];
                                                                  remotePeer: PeerId;
                                                              }

                                                              Properties

                                                              addrs remotePeer -

                                                              Properties

                                                              addrs

                                                              addrs: Multiaddr[]

                                                              remotePeer

                                                              remotePeer: PeerId

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              addrsremotePeer
                                                              \ No newline at end of file +

                                                              Properties

                                                              addrs

                                                              addrs: Multiaddr[]

                                                              remotePeer

                                                              remotePeer: PeerId

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              addrsremotePeer
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_compliance_tests.mocks.MockNetworkComponents.html b/interfaces/_libp2p_interface_compliance_tests.mocks.MockNetworkComponents.html index dab34e040e..f96d6e7c23 100644 --- a/interfaces/_libp2p_interface_compliance_tests.mocks.MockNetworkComponents.html +++ b/interfaces/_libp2p_interface_compliance_tests.mocks.MockNetworkComponents.html @@ -1,8 +1,8 @@ -MockNetworkComponents | libp2p

                                                              Interface MockNetworkComponents

                                                              interface MockNetworkComponents {
                                                                  connectionManager: ConnectionManager;
                                                                  events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                                  logger: ComponentLogger;
                                                                  peerId: PeerId;
                                                                  privateKey: PrivateKey;
                                                                  pubsub?: PubSub<PubSubEvents>;
                                                                  registrar: Registrar;
                                                              }

                                                              Properties

                                                              connectionManager +MockNetworkComponents | libp2p

                                                              Interface MockNetworkComponents

                                                              interface MockNetworkComponents {
                                                                  connectionManager: ConnectionManager;
                                                                  events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                                  logger: ComponentLogger;
                                                                  peerId: PeerId;
                                                                  privateKey: PrivateKey;
                                                                  pubsub?: PubSub<PubSubEvents>;
                                                                  registrar: Registrar;
                                                              }

                                                              Properties

                                                              connectionManager events logger peerId privateKey pubsub? registrar -

                                                              Properties

                                                              connectionManager

                                                              connectionManager: ConnectionManager

                                                              events

                                                              events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                                              logger

                                                              logger: ComponentLogger

                                                              peerId

                                                              peerId: PeerId

                                                              privateKey

                                                              privateKey: PrivateKey

                                                              Optional pubsub

                                                              pubsub?: PubSub<PubSubEvents>

                                                              registrar

                                                              registrar: Registrar

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              connectionManagereventsloggerpeerIdprivateKeypubsubregistrar
                                                              \ No newline at end of file +

                                                              Properties

                                                              connectionManager

                                                              connectionManager: ConnectionManager

                                                              events

                                                              events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                                              logger

                                                              logger: ComponentLogger

                                                              peerId

                                                              peerId: PeerId

                                                              privateKey

                                                              privateKey: PrivateKey

                                                              Optional pubsub

                                                              pubsub?: PubSub<PubSubEvents>

                                                              registrar

                                                              registrar: Registrar

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              connectionManagereventsloggerpeerIdprivateKeypubsubregistrar
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_compliance_tests.mocks.MockUpgraderInit.html b/interfaces/_libp2p_interface_compliance_tests.mocks.MockUpgraderInit.html index c397278beb..da3722c3e2 100644 --- a/interfaces/_libp2p_interface_compliance_tests.mocks.MockUpgraderInit.html +++ b/interfaces/_libp2p_interface_compliance_tests.mocks.MockUpgraderInit.html @@ -1,3 +1,3 @@ -MockUpgraderInit | libp2p

                                                              Interface MockUpgraderInit

                                                              interface MockUpgraderInit {
                                                                  events?: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                                  registrar?: Registrar;
                                                              }

                                                              Properties

                                                              events? +MockUpgraderInit | libp2p

                                                              Interface MockUpgraderInit

                                                              interface MockUpgraderInit {
                                                                  events?: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                                  registrar?: Registrar;
                                                              }

                                                              Properties

                                                              events? registrar? -

                                                              Properties

                                                              Optional events

                                                              events?: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                                              Optional registrar

                                                              registrar?: Registrar

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              eventsregistrar
                                                              \ No newline at end of file +

                                                              Properties

                                                              Optional events

                                                              events?: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                                              Optional registrar

                                                              registrar?: Registrar

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              eventsregistrar
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_compliance_tests.mocks.StreamInit.html b/interfaces/_libp2p_interface_compliance_tests.mocks.StreamInit.html index eb29cc6fa5..56c442834a 100644 --- a/interfaces/_libp2p_interface_compliance_tests.mocks.StreamInit.html +++ b/interfaces/_libp2p_interface_compliance_tests.mocks.StreamInit.html @@ -1,4 +1,4 @@ -StreamInit | libp2p

                                                              Interface StreamInit

                                                              interface StreamInit {
                                                                  direction?: Direction;
                                                                  id?: string;
                                                                  protocol?: string;
                                                              }

                                                              Properties

                                                              direction? +StreamInit | libp2p

                                                              Interface StreamInit

                                                              interface StreamInit {
                                                                  direction?: Direction;
                                                                  id?: string;
                                                                  protocol?: string;
                                                              }

                                                              Properties

                                                              direction? id? protocol? -

                                                              Properties

                                                              Optional direction

                                                              direction?: Direction

                                                              Optional id

                                                              id?: string

                                                              Optional protocol

                                                              protocol?: string

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              directionidprotocol
                                                              \ No newline at end of file +

                                                              Properties

                                                              Optional direction

                                                              direction?: Direction

                                                              Optional id

                                                              id?: string

                                                              Optional protocol

                                                              protocol?: string

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              directionidprotocol
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_compliance_tests.mocks.StreamPairInit.html b/interfaces/_libp2p_interface_compliance_tests.mocks.StreamPairInit.html index 24a1dee387..7787ea0fc6 100644 --- a/interfaces/_libp2p_interface_compliance_tests.mocks.StreamPairInit.html +++ b/interfaces/_libp2p_interface_compliance_tests.mocks.StreamPairInit.html @@ -1,3 +1,3 @@ -StreamPairInit | libp2p

                                                              Interface StreamPairInit

                                                              interface StreamPairInit {
                                                                  duplex: Duplex<AsyncGenerator<Uint8ArrayList, any, unknown>, Source<Uint8Array | Uint8ArrayList>, Promise<void>>;
                                                                  init?: StreamInit;
                                                              }

                                                              Properties

                                                              duplex +StreamPairInit | libp2p

                                                              Interface StreamPairInit

                                                              interface StreamPairInit {
                                                                  duplex: Duplex<AsyncGenerator<Uint8ArrayList, any, unknown>, Source<Uint8Array | Uint8ArrayList>, Promise<void>>;
                                                                  init?: StreamInit;
                                                              }

                                                              Properties

                                                              duplex init? -

                                                              Properties

                                                              duplex

                                                              duplex: Duplex<AsyncGenerator<Uint8ArrayList, any, unknown>, Source<Uint8Array | Uint8ArrayList>, Promise<void>>

                                                              Optional init

                                                              init?: StreamInit

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              duplexinit
                                                              \ No newline at end of file +

                                                              Properties

                                                              duplex

                                                              duplex: Duplex<AsyncGenerator<Uint8ArrayList, any, unknown>, Source<Uint8Array | Uint8ArrayList>, Promise<void>>

                                                              Optional init

                                                              init?: StreamInit

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              duplexinit
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_compliance_tests.pubsub.PubSubArgs.html b/interfaces/_libp2p_interface_compliance_tests.pubsub.PubSubArgs.html index 7b983b0fd5..63ecdf75a1 100644 --- a/interfaces/_libp2p_interface_compliance_tests.pubsub.PubSubArgs.html +++ b/interfaces/_libp2p_interface_compliance_tests.pubsub.PubSubArgs.html @@ -1,3 +1,3 @@ -PubSubArgs | libp2p

                                                              Interface PubSubArgs

                                                              interface PubSubArgs {
                                                                  components: PubSubComponents;
                                                                  init: PubSubInit;
                                                              }

                                                              Properties

                                                              components +PubSubArgs | libp2p

                                                              Interface PubSubArgs

                                                              interface PubSubArgs {
                                                                  components: PubSubComponents;
                                                                  init: PubSubInit;
                                                              }

                                                              Properties

                                                              components init -

                                                              Properties

                                                              components

                                                              components: PubSubComponents

                                                              init

                                                              init: PubSubInit

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              componentsinit
                                                              \ No newline at end of file +

                                                              Properties

                                                              components

                                                              components: PubSubComponents

                                                              init

                                                              init: PubSubInit

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              componentsinit
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_compliance_tests.pubsub.PubSubComponents.html b/interfaces/_libp2p_interface_compliance_tests.pubsub.PubSubComponents.html index 33054e729d..86b28ccd78 100644 --- a/interfaces/_libp2p_interface_compliance_tests.pubsub.PubSubComponents.html +++ b/interfaces/_libp2p_interface_compliance_tests.pubsub.PubSubComponents.html @@ -1,7 +1,7 @@ -PubSubComponents | libp2p

                                                              Interface PubSubComponents

                                                              interface PubSubComponents {
                                                                  connectionManager: ConnectionManager;
                                                                  logger: ComponentLogger;
                                                                  peerId: PeerId;
                                                                  privateKey: PrivateKey;
                                                                  pubsub?: PubSub<PubSubEvents>;
                                                                  registrar: Registrar;
                                                              }

                                                              Properties

                                                              connectionManager +PubSubComponents | libp2p

                                                              Interface PubSubComponents

                                                              interface PubSubComponents {
                                                                  connectionManager: ConnectionManager;
                                                                  logger: ComponentLogger;
                                                                  peerId: PeerId;
                                                                  privateKey: PrivateKey;
                                                                  pubsub?: PubSub<PubSubEvents>;
                                                                  registrar: Registrar;
                                                              }

                                                              Properties

                                                              connectionManager logger peerId privateKey pubsub? registrar -

                                                              Properties

                                                              connectionManager

                                                              connectionManager: ConnectionManager

                                                              logger

                                                              logger: ComponentLogger

                                                              peerId

                                                              peerId: PeerId

                                                              privateKey

                                                              privateKey: PrivateKey

                                                              Optional pubsub

                                                              pubsub?: PubSub<PubSubEvents>

                                                              registrar

                                                              registrar: Registrar

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              connectionManagerloggerpeerIdprivateKeypubsubregistrar
                                                              \ No newline at end of file +

                                                              Properties

                                                              connectionManager

                                                              connectionManager: ConnectionManager

                                                              logger

                                                              logger: ComponentLogger

                                                              peerId

                                                              peerId: PeerId

                                                              privateKey

                                                              privateKey: PrivateKey

                                                              Optional pubsub

                                                              pubsub?: PubSub<PubSubEvents>

                                                              registrar

                                                              registrar: Registrar

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              connectionManagerloggerpeerIdprivateKeypubsubregistrar
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_compliance_tests.transport.TransportTestFixtures.html b/interfaces/_libp2p_interface_compliance_tests.transport.TransportTestFixtures.html index a71a5c5f03..4c8fb4eeb1 100644 --- a/interfaces/_libp2p_interface_compliance_tests.transport.TransportTestFixtures.html +++ b/interfaces/_libp2p_interface_compliance_tests.transport.TransportTestFixtures.html @@ -1,12 +1,12 @@ -TransportTestFixtures | libp2p

                                                              Interface TransportTestFixtures

                                                              interface TransportTestFixtures {
                                                                  dialAddrs?: [Multiaddr, Multiaddr];
                                                                  dialMultiaddrMatcher: MultiaddrMatcher;
                                                                  dialer: Libp2pInit<ServiceMap>;
                                                                  listenMultiaddrMatcher: MultiaddrMatcher;
                                                                  listener?: Libp2pInit<ServiceMap>;
                                                              }

                                                              Properties

                                                              dialAddrs? +TransportTestFixtures | libp2p

                                                              Interface TransportTestFixtures

                                                              interface TransportTestFixtures {
                                                                  dialAddrs?: [Multiaddr, Multiaddr];
                                                                  dialMultiaddrMatcher: MultiaddrMatcher;
                                                                  dialer: Libp2pInit<ServiceMap>;
                                                                  listenMultiaddrMatcher: MultiaddrMatcher;
                                                                  listener?: Libp2pInit<ServiceMap>;
                                                              }

                                                              Properties

                                                              dialAddrs? dialMultiaddrMatcher dialer listenMultiaddrMatcher listener?

                                                              Properties

                                                              Optional dialAddrs

                                                              dialAddrs?: [Multiaddr, Multiaddr]

                                                              Addresses that will be used to dial listeners - both addresses must resolve to the same node

                                                              -

                                                              dialMultiaddrMatcher

                                                              dialMultiaddrMatcher: MultiaddrMatcher

                                                              Filter out any addresses that cannot be dialed by the transport

                                                              -

                                                              dialer

                                                              dialer: Libp2pInit<ServiceMap>

                                                              Config that creates a libp2p node that can dial a listener

                                                              -

                                                              listenMultiaddrMatcher

                                                              listenMultiaddrMatcher: MultiaddrMatcher

                                                              Filter out any addresses that cannot be listened on by the transport

                                                              -

                                                              Optional listener

                                                              listener?: Libp2pInit<ServiceMap>

                                                              Config that creates a libp2p node that can accept dials

                                                              -

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              dialAddrsdialMultiaddrMatcherdialerlistenMultiaddrMatcherlistener
                                                              \ No newline at end of file +

                                                              dialMultiaddrMatcher

                                                              dialMultiaddrMatcher: MultiaddrMatcher

                                                              Filter out any addresses that cannot be dialed by the transport

                                                              +

                                                              dialer

                                                              dialer: Libp2pInit<ServiceMap>

                                                              Config that creates a libp2p node that can dial a listener

                                                              +

                                                              listenMultiaddrMatcher

                                                              listenMultiaddrMatcher: MultiaddrMatcher

                                                              Filter out any addresses that cannot be listened on by the transport

                                                              +

                                                              Optional listener

                                                              listener?: Libp2pInit<ServiceMap>

                                                              Config that creates a libp2p node that can accept dials

                                                              +

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              dialAddrsdialMultiaddrMatcherdialerlistenMultiaddrMatcherlistener
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.AddressManager.html b/interfaces/_libp2p_interface_internal.AddressManager.html index e4e6ddf7dc..42e2a3d64b 100644 --- a/interfaces/_libp2p_interface_internal.AddressManager.html +++ b/interfaces/_libp2p_interface_internal.AddressManager.html @@ -1,4 +1,4 @@ -AddressManager | libp2p

                                                              Interface AddressManager

                                                              interface AddressManager {
                                                                  addDNSMapping(domain, ipAddresses): void;
                                                                  addObservedAddr(addr): void;
                                                                  addPublicAddressMapping(internalIp, internalPort, externalIp, externalPort?, protocol?): void;
                                                                  confirmObservedAddr(addr, options?): void;
                                                                  getAddresses(): Multiaddr[];
                                                                  getAddressesWithMetadata(): NodeAddress[];
                                                                  getAnnounceAddrs(): Multiaddr[];
                                                                  getListenAddrs(): Multiaddr[];
                                                                  getObservedAddrs(): Multiaddr[];
                                                                  removeDNSMapping(domain): void;
                                                                  removeObservedAddr(addr): void;
                                                                  removePublicAddressMapping(internalIp, internalPort, externalIp, externalPort?, protocol?): void;
                                                              }

                                                              Methods

                                                              addDNSMapping +AddressManager | libp2p

                                                              Interface AddressManager

                                                              interface AddressManager {
                                                                  addDNSMapping(domain, ipAddresses): void;
                                                                  addObservedAddr(addr): void;
                                                                  addPublicAddressMapping(internalIp, internalPort, externalIp, externalPort?, protocol?): void;
                                                                  confirmObservedAddr(addr, options?): void;
                                                                  getAddresses(): Multiaddr[];
                                                                  getAddressesWithMetadata(): NodeAddress[];
                                                                  getAnnounceAddrs(): Multiaddr[];
                                                                  getListenAddrs(): Multiaddr[];
                                                                  getObservedAddrs(): Multiaddr[];
                                                                  removeDNSMapping(domain): void;
                                                                  removeObservedAddr(addr): void;
                                                                  removePublicAddressMapping(internalIp, internalPort, externalIp, externalPort?, protocol?): void;
                                                              }

                                                              Methods

                                                              addDNSMapping addObservedAddr addPublicAddressMapping confirmObservedAddr @@ -14,26 +14,26 @@ getAddresses is invoked, where the IP addresses are present in a multiaddr, an additional multiaddr will be added with ip4 and ip6 tuples replaced with dns4 and `dns6 ones respectively.

                                                              -

                                                              Parameters

                                                              • domain: string
                                                              • ipAddresses: string[]

                                                              Returns void

                                                              addObservedAddr

                                                              addObservedAddr

                                                              addPublicAddressMapping

                                                              addPublicAddressMapping

                                                              • addPublicAddressMapping(internalIp, internalPort, externalIp, externalPort?, protocol?): void

                                                              • Add a publicly routable address/port/protocol tuple that this node is reachable on. Where this node listens on a link-local (e.g. LAN) address with the same protocol for any transport, an additional listen address will be added with the IP and port replaced with this IP and port.

                                                                It's possible to add a IPv6 address here and have it added to the address list, this is for the case when a router has an external IPv6 address with port forwarding configured, but it does IPv6 -> IPv4 NAT.

                                                                -

                                                                Parameters

                                                                • internalIp: string
                                                                • internalPort: number
                                                                • externalIp: string
                                                                • Optional externalPort: number
                                                                • Optional protocol: "tcp" | "udp"

                                                                Returns void

                                                              confirmObservedAddr

                                                              • confirmObservedAddr(addr, options?): void

                                                              • Signal that we have confidence an observed multiaddr is publicly dialable - +

                                                                Parameters

                                                                • internalIp: string
                                                                • internalPort: number
                                                                • externalIp: string
                                                                • Optional externalPort: number
                                                                • Optional protocol: "tcp" | "udp"

                                                                Returns void

                                                              confirmObservedAddr

                                                              getAddresses

                                                              getAddressesWithMetadata

                                                              getAnnounceAddrs

                                                              getListenAddrs

                                                              getObservedAddrs

                                                              getAddresses

                                                              getAddressesWithMetadata

                                                              getAnnounceAddrs

                                                              getListenAddrs

                                                              getObservedAddrs

                                                              removeDNSMapping

                                                              removeObservedAddr

                                                              removeDNSMapping

                                                              removeObservedAddr

                                                              removePublicAddressMapping

                                                              • removePublicAddressMapping(internalIp, internalPort, externalIp, externalPort?, protocol?): void

                                                              • Remove a publicly routable address that this node is no longer reachable on

                                                                -

                                                                Parameters

                                                                • internalIp: string
                                                                • internalPort: number
                                                                • externalIp: string
                                                                • Optional externalPort: number
                                                                • Optional protocol: "tcp" | "udp"

                                                                Returns void

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              addDNSMappingaddObservedAddraddPublicAddressMappingconfirmObservedAddrgetAddressesgetAddressesWithMetadatagetAnnounceAddrsgetListenAddrsgetObservedAddrsremoveDNSMappingremoveObservedAddrremovePublicAddressMapping
                                                              \ No newline at end of file +

                                                              Parameters

                                                              Returns void

                                                              removePublicAddressMapping

                                                              • removePublicAddressMapping(internalIp, internalPort, externalIp, externalPort?, protocol?): void

                                                              • Remove a publicly routable address that this node is no longer reachable on

                                                                +

                                                                Parameters

                                                                • internalIp: string
                                                                • internalPort: number
                                                                • externalIp: string
                                                                • Optional externalPort: number
                                                                • Optional protocol: "tcp" | "udp"

                                                                Returns void

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              addDNSMappingaddObservedAddraddPublicAddressMappingconfirmObservedAddrgetAddressesgetAddressesWithMetadatagetAnnounceAddrsgetListenAddrsgetObservedAddrsremoveDNSMappingremoveObservedAddrremovePublicAddressMapping
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.ConfirmAddressOptions.html b/interfaces/_libp2p_interface_internal.ConfirmAddressOptions.html index 09ffb97813..38682ce793 100644 --- a/interfaces/_libp2p_interface_internal.ConfirmAddressOptions.html +++ b/interfaces/_libp2p_interface_internal.ConfirmAddressOptions.html @@ -1,5 +1,5 @@ -ConfirmAddressOptions | libp2p

                                                              Interface ConfirmAddressOptions

                                                              interface ConfirmAddressOptions {
                                                                  ttl?: number;
                                                                  type?: AddressType;
                                                              }

                                                              Properties

                                                              ttl? +ConfirmAddressOptions | libp2p

                                                              Interface ConfirmAddressOptions

                                                              interface ConfirmAddressOptions {
                                                                  ttl?: number;
                                                                  type?: AddressType;
                                                              }

                                                              Properties

                                                              ttl? type?

                                                              Properties

                                                              Optional ttl

                                                              ttl?: number

                                                              Override the TTL of the observed address verification

                                                              -

                                                              Optional type

                                                              type?: AddressType

                                                              Allows hinting which type of address this is

                                                              -

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              ttltype
                                                              \ No newline at end of file +

                                                              Optional type

                                                              type?: AddressType

                                                              Allows hinting which type of address this is

                                                              +

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              ttltype
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.ConnectionManager.html b/interfaces/_libp2p_interface_internal.ConnectionManager.html index 6fb73c3d83..bc0df18f6a 100644 --- a/interfaces/_libp2p_interface_internal.ConnectionManager.html +++ b/interfaces/_libp2p_interface_internal.ConnectionManager.html @@ -1,4 +1,4 @@ -ConnectionManager | libp2p

                                                              Interface ConnectionManager

                                                              interface ConnectionManager {
                                                                  acceptIncomingConnection(maConn): Promise<boolean>;
                                                                  afterUpgradeInbound(): void;
                                                                  closeConnections(peer, options?): Promise<void>;
                                                                  getConnections(peerId?): Connection[];
                                                                  getConnectionsMap(): PeerMap<Connection[]>;
                                                                  getDialQueue(): PendingDial[];
                                                                  getMaxConnections(): number;
                                                                  isDialable(multiaddr, options?): Promise<boolean>;
                                                                  openConnection(peer, options?): Promise<Connection>;
                                                              }

                                                              Methods

                                                              acceptIncomingConnection +ConnectionManager | libp2p

                                                              Interface ConnectionManager

                                                              interface ConnectionManager {
                                                                  acceptIncomingConnection(maConn): Promise<boolean>;
                                                                  afterUpgradeInbound(): void;
                                                                  closeConnections(peer, options?): Promise<void>;
                                                                  getConnections(peerId?): Connection[];
                                                                  getConnectionsMap(): PeerMap<Connection[]>;
                                                                  getDialQueue(): PendingDial[];
                                                                  getMaxConnections(): number;
                                                                  isDialable(multiaddr, options?): Promise<boolean>;
                                                                  openConnection(peer, options?): Promise<Connection>;
                                                              }

                                                              Methods

                                                              acceptIncomingConnection afterUpgradeInbound closeConnections getConnections @@ -11,25 +11,25 @@ exchanged, this lets the ConnectionManager check we have sufficient resources to accept the connection in which case it will return true, otherwise it will return false.

                                                              -

                                                              Parameters

                                                              Returns Promise<boolean>

                                                              afterUpgradeInbound

                                                              closeConnections

                                                              getConnections

                                                              afterUpgradeInbound

                                                              closeConnections

                                                              getConnections

                                                              getConnectionsMap

                                                              getConnectionsMap

                                                              getDialQueue

                                                              getDialQueue

                                                              getMaxConnections

                                                              getMaxConnections

                                                              isDialable

                                                              isDialable

                                                              openConnection

                                                              openConnection

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              acceptIncomingConnectionafterUpgradeInboundcloseConnectionsgetConnectionsgetConnectionsMapgetDialQueuegetMaxConnectionsisDialableopenConnection
                                                              \ No newline at end of file +

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              acceptIncomingConnectionafterUpgradeInboundcloseConnectionsgetConnectionsgetConnectionsMapgetDialQueuegetMaxConnectionsisDialableopenConnection
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.Envelope.html b/interfaces/_libp2p_interface_internal.Envelope.html index df46db2a45..1336fa6e38 100644 --- a/interfaces/_libp2p_interface_internal.Envelope.html +++ b/interfaces/_libp2p_interface_internal.Envelope.html @@ -1,8 +1,8 @@ -Envelope | libp2p

                                                              Interface Envelope

                                                              interface Envelope {
                                                                  payload: Uint8Array;
                                                                  payloadType: Uint8Array | Uint8ArrayList;
                                                                  peerId: PeerId;
                                                                  signature: Uint8Array | Uint8ArrayList;
                                                                  equals(other): boolean;
                                                                  marshal(): Uint8Array;
                                                                  validate(domain): Promise<boolean>;
                                                              }

                                                              Properties

                                                              payload +Envelope | libp2p

                                                              Interface Envelope

                                                              interface Envelope {
                                                                  payload: Uint8Array;
                                                                  payloadType: Uint8Array | Uint8ArrayList;
                                                                  peerId: PeerId;
                                                                  signature: Uint8Array | Uint8ArrayList;
                                                                  equals(other): boolean;
                                                                  marshal(): Uint8Array;
                                                                  validate(domain): Promise<boolean>;
                                                              }

                                                              Properties

                                                              payload payloadType peerId signature

                                                              Methods

                                                              equals marshal validate -

                                                              Properties

                                                              payload

                                                              payload: Uint8Array

                                                              payloadType

                                                              payloadType: Uint8Array | Uint8ArrayList

                                                              peerId

                                                              peerId: PeerId

                                                              signature

                                                              signature: Uint8Array | Uint8ArrayList

                                                              Methods

                                                              equals

                                                              marshal

                                                              validate

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              payloadpayloadTypepeerIdsignatureequalsmarshalvalidate
                                                              \ No newline at end of file +

                                                              Properties

                                                              payload

                                                              payload: Uint8Array

                                                              payloadType

                                                              payloadType: Uint8Array | Uint8ArrayList

                                                              peerId

                                                              peerId: PeerId

                                                              signature

                                                              signature: Uint8Array | Uint8ArrayList

                                                              Methods

                                                              equals

                                                              marshal

                                                              validate

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              payloadpayloadTypepeerIdsignatureequalsmarshalvalidate
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.IncomingStreamData.html b/interfaces/_libp2p_interface_internal.IncomingStreamData.html index dd897b64d3..145e3a5f3b 100644 --- a/interfaces/_libp2p_interface_internal.IncomingStreamData.html +++ b/interfaces/_libp2p_interface_internal.IncomingStreamData.html @@ -1,5 +1,5 @@ -IncomingStreamData | libp2p

                                                              Interface IncomingStreamData

                                                              interface IncomingStreamData {
                                                                  connection: Connection;
                                                                  stream: Stream;
                                                              }

                                                              Properties

                                                              connection +IncomingStreamData | libp2p

                                                              Interface IncomingStreamData

                                                              interface IncomingStreamData {
                                                                  connection: Connection;
                                                                  stream: Stream;
                                                              }

                                                              Properties

                                                              connection stream

                                                              Properties

                                                              connection

                                                              connection: Connection

                                                              The connection that the stream was opened on

                                                              -

                                                              stream

                                                              stream: Stream

                                                              The stream that has been opened

                                                              -

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              connectionstream
                                                              \ No newline at end of file +

                                                              stream

                                                              stream: Stream

                                                              The stream that has been opened

                                                              +

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              connectionstream
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.NodeAddress.html b/interfaces/_libp2p_interface_internal.NodeAddress.html index 158f2b18ac..99901b8ad3 100644 --- a/interfaces/_libp2p_interface_internal.NodeAddress.html +++ b/interfaces/_libp2p_interface_internal.NodeAddress.html @@ -1,15 +1,15 @@ NodeAddress | libp2p

                                                              Interface NodeAddress

                                                              An address that has been configured or detected

                                                              -
                                                              interface NodeAddress {
                                                                  expires: number;
                                                                  lastVerified?: number;
                                                                  multiaddr: Multiaddr;
                                                                  type: AddressType;
                                                                  verified: boolean;
                                                              }

                                                              Properties

                                                              expires +
                                                              interface NodeAddress {
                                                                  expires: number;
                                                                  lastVerified?: number;
                                                                  multiaddr: Multiaddr;
                                                                  type: AddressType;
                                                                  verified: boolean;
                                                              }

                                                              Properties

                                                              expires lastVerified? multiaddr type verified

                                                              Properties

                                                              expires

                                                              expires: number

                                                              A millisecond timestamp after which this address should be reverified

                                                              -

                                                              Optional lastVerified

                                                              lastVerified?: number

                                                              The timestamp at which the address was last verified

                                                              -

                                                              multiaddr

                                                              multiaddr: Multiaddr

                                                              The multiaddr that represents the address

                                                              -

                                                              type

                                                              type: AddressType

                                                              The source of this address

                                                              -

                                                              verified

                                                              verified: boolean

                                                              Dynamically configured addresses such as observed or IP/DNS mapped ones +

                                                              Optional lastVerified

                                                              lastVerified?: number

                                                              The timestamp at which the address was last verified

                                                              +

                                                              multiaddr

                                                              multiaddr: Multiaddr

                                                              The multiaddr that represents the address

                                                              +

                                                              type

                                                              type: AddressType

                                                              The source of this address

                                                              +

                                                              verified

                                                              verified: boolean

                                                              Dynamically configured addresses such as observed or IP/DNS mapped ones must be verified as valid by AutoNAT or some other means before the current node will add them to it's peer record and share them with peers.

                                                              When this value is true, it's safe to share the address.

                                                              -

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              expireslastVerifiedmultiaddrtypeverified
                                                              \ No newline at end of file +

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              expireslastVerifiedmultiaddrtypeverified
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.OpenConnectionOptions.html b/interfaces/_libp2p_interface_internal.OpenConnectionOptions.html index 7b7e4c27d5..57960fa1a9 100644 --- a/interfaces/_libp2p_interface_internal.OpenConnectionOptions.html +++ b/interfaces/_libp2p_interface_internal.OpenConnectionOptions.html @@ -2,7 +2,7 @@ the optional signal property.

                                                              Example

                                                              const controller = new AbortController()

                                                              aLongRunningOperation({
                                                                signal: controller.signal
                                                              })

                                                              // later

                                                              controller.abort()
                                                              -
                                                              interface OpenConnectionOptions {
                                                                  force?: boolean;
                                                                  onProgress?: ((evt) => void);
                                                                  priority?: number;
                                                                  signal?: AbortSignal;
                                                              }

                                                              Hierarchy (view full)

                                                              Properties

                                                              force? +
                                                              interface OpenConnectionOptions {
                                                                  force?: boolean;
                                                                  onProgress?: ((evt) => void);
                                                                  priority?: number;
                                                                  signal?: AbortSignal;
                                                              }

                                                              Hierarchy (view full)

                                                              Properties

                                                              force? onProgress? priority? signal? @@ -11,8 +11,8 @@ to override that and dial a new connection anyway.

                                                              Default

                                                              false
                                                              -

                                                              Optional onProgress

                                                              onProgress?: ((evt) => void)

                                                              Type declaration

                                                              Optional priority

                                                              priority?: number

                                                              Connection requests with a higher priority will be executed before those +

                                                              Optional onProgress

                                                              onProgress?: ((evt) => void)

                                                              Type declaration

                                                              Optional priority

                                                              priority?: number

                                                              Connection requests with a higher priority will be executed before those with a lower priority.

                                                              Default

                                                              50
                                                              -

                                                              Optional signal

                                                              signal?: AbortSignal

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              forceonProgressprioritysignal
                                                              \ No newline at end of file +

                                                              Optional signal

                                                              signal?: AbortSignal

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              forceonProgressprioritysignal
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.RandomWalk.html b/interfaces/_libp2p_interface_internal.RandomWalk.html index cdd4d64da8..601c963c9b 100644 --- a/interfaces/_libp2p_interface_internal.RandomWalk.html +++ b/interfaces/_libp2p_interface_internal.RandomWalk.html @@ -1,6 +1,6 @@ RandomWalk | libp2p

                                                              Interface RandomWalk

                                                              RandomWalk finds random peers on the network and dials them. Use this after registering a Topology if you need to discover common network services.

                                                              -
                                                              interface RandomWalk {
                                                                  walk(options?): AsyncGenerator<PeerInfo, any, unknown>;
                                                              }

                                                              Methods

                                                              walk +
                                                              interface RandomWalk {
                                                                  walk(options?): AsyncGenerator<PeerInfo, any, unknown>;
                                                              }

                                                              Methods

                                                              walk

                                                              Methods

                                                              walk

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              walk
                                                              \ No newline at end of file +

                                                              Parameters

                                                              Returns AsyncGenerator<PeerInfo, any, unknown>

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              walk
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.Record.html b/interfaces/_libp2p_interface_internal.Record.html index f976a2263b..156fe16f2d 100644 --- a/interfaces/_libp2p_interface_internal.Record.html +++ b/interfaces/_libp2p_interface_internal.Record.html @@ -1,10 +1,10 @@ Record | libp2p

                                                              Interface Record

                                                              Record is the base implementation of a record that can be used as the payload of a libp2p envelope.

                                                              -
                                                              interface Record {
                                                                  codec: Uint8Array;
                                                                  domain: string;
                                                                  equals(other): boolean;
                                                                  marshal(): Uint8Array;
                                                              }

                                                              Properties

                                                              codec +
                                                              interface Record {
                                                                  codec: Uint8Array;
                                                                  domain: string;
                                                                  equals(other): boolean;
                                                                  marshal(): Uint8Array;
                                                              }

                                                              Properties

                                                              codec domain

                                                              Methods

                                                              equals marshal

                                                              Properties

                                                              codec

                                                              codec: Uint8Array

                                                              identifier of the type of record

                                                              -

                                                              domain

                                                              domain: string

                                                              signature domain.

                                                              -

                                                              Methods

                                                              equals

                                                              marshal

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              codecdomainequalsmarshal
                                                              \ No newline at end of file +

                                                              domain

                                                              domain: string

                                                              signature domain.

                                                              +

                                                              Methods

                                                              equals

                                                              marshal

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              codecdomainequalsmarshal
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.Registrar.html b/interfaces/_libp2p_interface_internal.Registrar.html index 022ab29152..5f98deeb64 100644 --- a/interfaces/_libp2p_interface_internal.Registrar.html +++ b/interfaces/_libp2p_interface_internal.Registrar.html @@ -1,4 +1,4 @@ -Registrar | libp2p

                                                              Interface Registrar

                                                              interface Registrar {
                                                                  getHandler(protocol): StreamHandlerRecord;
                                                                  getProtocols(): string[];
                                                                  getTopologies(protocol): Topology[];
                                                                  handle(protocol, handler, options?): Promise<void>;
                                                                  register(protocol, topology): Promise<string>;
                                                                  unhandle(protocol): Promise<void>;
                                                                  unregister(id): void;
                                                              }

                                                              Methods

                                                              getHandler +Registrar | libp2p

                                                              Interface Registrar

                                                              interface Registrar {
                                                                  getHandler(protocol): StreamHandlerRecord;
                                                                  getProtocols(): string[];
                                                                  getTopologies(protocol): Topology[];
                                                                  handle(protocol, handler, options?): Promise<void>;
                                                                  register(protocol, topology): Promise<string>;
                                                                  unhandle(protocol): Promise<void>;
                                                                  unregister(id): void;
                                                              }

                                                              Methods

                                                              getHandler getProtocols getTopologies handle @@ -6,15 +6,15 @@ unhandle unregister

                                                              Methods

                                                              getHandler

                                                              getProtocols

                                                              getTopologies

                                                              getProtocols

                                                              getTopologies

                                                              handle

                                                              register

                                                              handle

                                                              register

                                                              • register(protocol, topology): Promise<string>

                                                              • Register a topology handler for a protocol - the topology will be invoked when peers are discovered on the network that support the passed protocol.

                                                                An id will be returned that can later be used to unregister the topology.

                                                                -

                                                                Parameters

                                                                Returns Promise<string>

                                                              unhandle

                                                              unregister

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              getHandlergetProtocolsgetTopologieshandleregisterunhandleunregister
                                                              \ No newline at end of file +

                                                              Parameters

                                                              Returns Promise<string>

                                                              unhandle

                                                              unregister

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              getHandlergetProtocolsgetTopologieshandleregisterunhandleunregister
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.StreamHandler.html b/interfaces/_libp2p_interface_internal.StreamHandler.html index 56895bc871..60c7867602 100644 --- a/interfaces/_libp2p_interface_internal.StreamHandler.html +++ b/interfaces/_libp2p_interface_internal.StreamHandler.html @@ -1 +1 @@ -StreamHandler | libp2p

                                                              Interface StreamHandler

                                                              interface StreamHandler ((data) => void)

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              \ No newline at end of file +StreamHandler | libp2p

                                                              Interface StreamHandler

                                                              interface StreamHandler ((data) => void)

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.StreamHandlerOptions.html b/interfaces/_libp2p_interface_internal.StreamHandlerOptions.html index 5a52262cb7..b8cc45a9cf 100644 --- a/interfaces/_libp2p_interface_internal.StreamHandlerOptions.html +++ b/interfaces/_libp2p_interface_internal.StreamHandlerOptions.html @@ -1,15 +1,15 @@ -StreamHandlerOptions | libp2p

                                                              Interface StreamHandlerOptions

                                                              interface StreamHandlerOptions {
                                                                  maxInboundStreams?: number;
                                                                  maxOutboundStreams?: number;
                                                                  runOnLimitedConnection?: boolean;
                                                              }

                                                              Properties

                                                              maxInboundStreams? +StreamHandlerOptions | libp2p

                                                              Interface StreamHandlerOptions

                                                              interface StreamHandlerOptions {
                                                                  maxInboundStreams?: number;
                                                                  maxOutboundStreams?: number;
                                                                  runOnLimitedConnection?: boolean;
                                                              }

                                                              Properties

                                                              maxInboundStreams? maxOutboundStreams? runOnLimitedConnection?

                                                              Properties

                                                              Optional maxInboundStreams

                                                              maxInboundStreams?: number

                                                              How many incoming streams can be open for this protocol at the same time on each connection

                                                              Default

                                                              32
                                                              -

                                                              Optional maxOutboundStreams

                                                              maxOutboundStreams?: number

                                                              How many outgoing streams can be open for this protocol at the same time on each connection

                                                              +

                                                              Optional maxOutboundStreams

                                                              maxOutboundStreams?: number

                                                              How many outgoing streams can be open for this protocol at the same time on each connection

                                                              Default

                                                              64
                                                              -

                                                              Optional runOnLimitedConnection

                                                              runOnLimitedConnection?: boolean

                                                              If true, allow this protocol to run on limited connections (e.g. +

                                                              Optional runOnLimitedConnection

                                                              runOnLimitedConnection?: boolean

                                                              If true, allow this protocol to run on limited connections (e.g. connections with data or duration limits such as circuit relay connections)

                                                              Default

                                                              false
                                                              -

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              maxInboundStreamsmaxOutboundStreamsrunOnLimitedConnection
                                                              \ No newline at end of file +

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              maxInboundStreamsmaxOutboundStreamsrunOnLimitedConnection
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.StreamHandlerRecord.html b/interfaces/_libp2p_interface_internal.StreamHandlerRecord.html index a58ba15b45..b18ff2951b 100644 --- a/interfaces/_libp2p_interface_internal.StreamHandlerRecord.html +++ b/interfaces/_libp2p_interface_internal.StreamHandlerRecord.html @@ -1,5 +1,5 @@ -StreamHandlerRecord | libp2p

                                                              Interface StreamHandlerRecord

                                                              interface StreamHandlerRecord {
                                                                  handler: StreamHandler;
                                                                  options: StreamHandlerOptions;
                                                              }

                                                              Properties

                                                              handler +StreamHandlerRecord | libp2p

                                                              Interface StreamHandlerRecord

                                                              interface StreamHandlerRecord {
                                                                  handler: StreamHandler;
                                                                  options: StreamHandlerOptions;
                                                              }

                                                              Properties

                                                              handler options

                                                              Properties

                                                              handler

                                                              handler: StreamHandler

                                                              The handler that was registered to handle streams opened on the protocol

                                                              -

                                                              options

                                                              options: StreamHandlerOptions

                                                              The options that were used to register the stream handler

                                                              -

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              handleroptions
                                                              \ No newline at end of file +

                                                              options

                                                              options: StreamHandlerOptions

                                                              The options that were used to register the stream handler

                                                              +

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              handleroptions
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.TransportManager.html b/interfaces/_libp2p_interface_internal.TransportManager.html index 9bde5d8fe4..ad3ad3fafd 100644 --- a/interfaces/_libp2p_interface_internal.TransportManager.html +++ b/interfaces/_libp2p_interface_internal.TransportManager.html @@ -1,4 +1,4 @@ -TransportManager | libp2p

                                                              Interface TransportManager

                                                              interface TransportManager {
                                                                  add(transport): void;
                                                                  dial(ma, options?): Promise<Connection>;
                                                                  dialTransportForMultiaddr(ma): undefined | Transport<ProgressEvent<any, unknown>>;
                                                                  getAddrs(): Multiaddr[];
                                                                  getListeners(): Listener[];
                                                                  getTransports(): Transport<ProgressEvent<any, unknown>>[];
                                                                  listen(addrs): Promise<void>;
                                                                  listenTransportForMultiaddr(ma): undefined | Transport<ProgressEvent<any, unknown>>;
                                                                  remove(key): Promise<void>;
                                                                  removeAll(): Promise<void>;
                                                              }

                                                              Methods

                                                              add +TransportManager | libp2p

                                                              Interface TransportManager

                                                              interface TransportManager {
                                                                  add(transport): void;
                                                                  dial(ma, options?): Promise<Connection>;
                                                                  dialTransportForMultiaddr(ma): undefined | Transport<ProgressEvent<any, unknown>>;
                                                                  getAddrs(): Multiaddr[];
                                                                  getListeners(): Listener[];
                                                                  getTransports(): Transport<ProgressEvent<any, unknown>>[];
                                                                  listen(addrs): Promise<void>;
                                                                  listenTransportForMultiaddr(ma): undefined | Transport<ProgressEvent<any, unknown>>;
                                                                  remove(key): Promise<void>;
                                                                  removeAll(): Promise<void>;
                                                              }

                                                              Methods

                                                              add dial dialTransportForMultiaddr getAddrs @@ -9,17 +9,17 @@ remove removeAll

                                                              Methods

                                                              add

                                                              dial

                                                              dial

                                                              dialTransportForMultiaddr

                                                              getAddrs

                                                              getListeners

                                                              getTransports

                                                              listen

                                                              listenTransportForMultiaddr

                                                              dialTransportForMultiaddr

                                                              getAddrs

                                                              getListeners

                                                              getTransports

                                                              listen

                                                              listenTransportForMultiaddr

                                                              remove

                                                              removeAll

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              adddialdialTransportForMultiaddrgetAddrsgetListenersgetTransportslistenlistenTransportForMultiaddrremoveremoveAll
                                                              \ No newline at end of file +

                                                              Parameters

                                                              Returns undefined | Transport<ProgressEvent<any, unknown>>

                                                              remove

                                                              removeAll

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              adddialdialTransportForMultiaddrgetAddrsgetListenersgetTransportslistenlistenTransportForMultiaddrremoveremoveAll
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.TransportManagerDialOptions.html b/interfaces/_libp2p_interface_internal.TransportManagerDialOptions.html index bf5a767608..8cc052a4c1 100644 --- a/interfaces/_libp2p_interface_internal.TransportManagerDialOptions.html +++ b/interfaces/_libp2p_interface_internal.TransportManagerDialOptions.html @@ -2,6 +2,6 @@ the optional signal property.

                                                              Example

                                                              const controller = new AbortController()

                                                              aLongRunningOperation({
                                                                signal: controller.signal
                                                              })

                                                              // later

                                                              controller.abort()
                                                              -
                                                              interface TransportManagerDialOptions {
                                                                  onProgress?: ((evt) => void);
                                                                  signal?: AbortSignal;
                                                              }

                                                              Hierarchy (view full)

                                                              Properties

                                                              onProgress? +
                                                              interface TransportManagerDialOptions {
                                                                  onProgress?: ((evt) => void);
                                                                  signal?: AbortSignal;
                                                              }

                                                              Hierarchy (view full)

                                                              Properties

                                                              onProgress? signal?

                                                              Properties

                                                              Optional onProgress

                                                              onProgress?: ((evt) => void)

                                                              Type declaration

                                                              Optional signal

                                                              signal?: AbortSignal

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              onProgresssignal
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.AddPeerEvent.html b/interfaces/_libp2p_kad_dht.AddPeerEvent.html index 1ad56b17ee..be04da5df1 100644 --- a/interfaces/_libp2p_kad_dht.AddPeerEvent.html +++ b/interfaces/_libp2p_kad_dht.AddPeerEvent.html @@ -1,5 +1,5 @@ AddPeerEvent | libp2p

                                                              Interface AddPeerEvent

                                                              Emitted when peers are added to a query

                                                              -
                                                              interface AddPeerEvent {
                                                                  name: "ADD_PEER";
                                                                  peer: PeerId;
                                                                  type: ADD_PEER;
                                                              }

                                                              Properties

                                                              name +
                                                              interface AddPeerEvent {
                                                                  name: "ADD_PEER";
                                                                  peer: PeerId;
                                                                  type: ADD_PEER;
                                                              }

                                                              Properties

                                                              name peer type -

                                                              Properties

                                                              name

                                                              name: "ADD_PEER"

                                                              peer

                                                              peer: PeerId

                                                              type

                                                              type: ADD_PEER

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              namepeertype
                                                              \ No newline at end of file +

                                                              Properties

                                                              name

                                                              name: "ADD_PEER"

                                                              peer

                                                              peer: PeerId

                                                              type

                                                              type: ADD_PEER

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              namepeertype
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.DHTRecord.html b/interfaces/_libp2p_kad_dht.DHTRecord.html index 2f9766e875..20bc62cfd1 100644 --- a/interfaces/_libp2p_kad_dht.DHTRecord.html +++ b/interfaces/_libp2p_kad_dht.DHTRecord.html @@ -1,4 +1,4 @@ -DHTRecord | libp2p

                                                              Interface DHTRecord

                                                              interface DHTRecord {
                                                                  key: Uint8Array;
                                                                  timeReceived?: Date;
                                                                  value: Uint8Array;
                                                              }

                                                              Properties

                                                              key +DHTRecord | libp2p

                                                              Interface DHTRecord

                                                              interface DHTRecord {
                                                                  key: Uint8Array;
                                                                  timeReceived?: Date;
                                                                  value: Uint8Array;
                                                              }

                                                              Properties

                                                              key timeReceived? value -

                                                              Properties

                                                              key

                                                              key: Uint8Array

                                                              Optional timeReceived

                                                              timeReceived?: Date

                                                              value

                                                              value: Uint8Array

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              keytimeReceivedvalue
                                                              \ No newline at end of file +

                                                              Properties

                                                              key

                                                              key: Uint8Array

                                                              Optional timeReceived

                                                              timeReceived?: Date

                                                              value

                                                              value: Uint8Array

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              keytimeReceivedvalue
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.DialPeerEvent.html b/interfaces/_libp2p_kad_dht.DialPeerEvent.html index 3bf849f18a..b3b4264efe 100644 --- a/interfaces/_libp2p_kad_dht.DialPeerEvent.html +++ b/interfaces/_libp2p_kad_dht.DialPeerEvent.html @@ -1,5 +1,5 @@ DialPeerEvent | libp2p

                                                              Interface DialPeerEvent

                                                              Emitted when peers are dialled as part of a query

                                                              -
                                                              interface DialPeerEvent {
                                                                  name: "DIAL_PEER";
                                                                  peer: PeerId;
                                                                  type: DIAL_PEER;
                                                              }

                                                              Properties

                                                              name +
                                                              interface DialPeerEvent {
                                                                  name: "DIAL_PEER";
                                                                  peer: PeerId;
                                                                  type: DIAL_PEER;
                                                              }

                                                              Properties

                                                              name peer type -

                                                              Properties

                                                              name

                                                              name: "DIAL_PEER"

                                                              peer

                                                              peer: PeerId

                                                              type

                                                              type: DIAL_PEER

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              namepeertype
                                                              \ No newline at end of file +

                                                              Properties

                                                              name

                                                              name: "DIAL_PEER"

                                                              peer

                                                              peer: PeerId

                                                              type

                                                              type: DIAL_PEER

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              namepeertype
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.FinalPeerEvent.html b/interfaces/_libp2p_kad_dht.FinalPeerEvent.html index 6cf0f7fd1d..453be508ff 100644 --- a/interfaces/_libp2p_kad_dht.FinalPeerEvent.html +++ b/interfaces/_libp2p_kad_dht.FinalPeerEvent.html @@ -1,6 +1,6 @@ FinalPeerEvent | libp2p

                                                              Interface FinalPeerEvent

                                                              Emitted at the end of a findPeer query

                                                              -
                                                              interface FinalPeerEvent {
                                                                  from: PeerId;
                                                                  name: "FINAL_PEER";
                                                                  peer: PeerInfo;
                                                                  type: FINAL_PEER;
                                                              }

                                                              Properties

                                                              from +
                                                              interface FinalPeerEvent {
                                                                  from: PeerId;
                                                                  name: "FINAL_PEER";
                                                                  peer: PeerInfo;
                                                                  type: FINAL_PEER;
                                                              }

                                                              Properties

                                                              from name peer type -

                                                              Properties

                                                              from

                                                              from: PeerId

                                                              name

                                                              name: "FINAL_PEER"

                                                              peer

                                                              peer: PeerInfo

                                                              type

                                                              type: FINAL_PEER

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              fromnamepeertype
                                                              \ No newline at end of file +

                                                              Properties

                                                              from

                                                              from: PeerId

                                                              name

                                                              name: "FINAL_PEER"

                                                              peer

                                                              peer: PeerInfo

                                                              type

                                                              type: FINAL_PEER

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              fromnamepeertype
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.KadDHT.html b/interfaces/_libp2p_kad_dht.KadDHT.html index 6a00c93007..044e8d1733 100644 --- a/interfaces/_libp2p_kad_dht.KadDHT.html +++ b/interfaces/_libp2p_kad_dht.KadDHT.html @@ -1,4 +1,4 @@ -KadDHT | libp2p

                                                              Interface KadDHT

                                                              interface KadDHT {
                                                                  cancelReprovide(key): Promise<void>;
                                                                  findPeer(id, options?): AsyncIterable<QueryEvent>;
                                                                  findProviders(key, options?): AsyncIterable<QueryEvent>;
                                                                  get(key, options?): AsyncIterable<QueryEvent>;
                                                                  getClosestPeers(key, options?): AsyncIterable<QueryEvent>;
                                                                  getMode(): "client" | "server";
                                                                  provide(key, options?): AsyncIterable<QueryEvent>;
                                                                  put(key, value, options?): AsyncIterable<QueryEvent>;
                                                                  refreshRoutingTable(): Promise<void>;
                                                                  setMode(mode): Promise<void>;
                                                              }

                                                              Hierarchy (view full)

                                                              Methods

                                                              cancelReprovide +KadDHT | libp2p

                                                              Interface KadDHT

                                                              interface KadDHT {
                                                                  cancelReprovide(key): Promise<void>;
                                                                  findPeer(id, options?): AsyncIterable<QueryEvent>;
                                                                  findProviders(key, options?): AsyncIterable<QueryEvent>;
                                                                  get(key, options?): AsyncIterable<QueryEvent>;
                                                                  getClosestPeers(key, options?): AsyncIterable<QueryEvent>;
                                                                  getMode(): "client" | "server";
                                                                  provide(key, options?): AsyncIterable<QueryEvent>;
                                                                  put(key, value, options?): AsyncIterable<QueryEvent>;
                                                                  refreshRoutingTable(): Promise<void>;
                                                                  setMode(mode): Promise<void>;
                                                              }

                                                              Hierarchy (view full)

                                                              Methods

                                                              cancelReprovide findPeer findProviders get @@ -10,14 +10,14 @@ setMode

                                                              Methods

                                                              cancelReprovide

                                                              • cancelReprovide(key): Promise<void>

                                                              • Provider records must be re-published every 24 hours - pass a previously provided CID here to not re-publish a record for it any more

                                                                -

                                                                Parameters

                                                                Returns Promise<void>

                                                              findPeer

                                                              findProviders

                                                              get

                                                              getClosestPeers

                                                              getMode

                                                              • getMode(): "client" | "server"

                                                              • Returns the mode this node is in

                                                                -

                                                                Returns "client" | "server"

                                                              provide

                                                              put

                                                              refreshRoutingTable

                                                              setMode

                                                              findPeer

                                                              findProviders

                                                              get

                                                              getClosestPeers

                                                              getMode

                                                              • getMode(): "client" | "server"

                                                              • Returns the mode this node is in

                                                                +

                                                                Returns "client" | "server"

                                                              provide

                                                              put

                                                              refreshRoutingTable

                                                              setMode

                                                              • setMode(mode): Promise<void>

                                                              • If 'server' this node will respond to DHT queries, if 'client' this node will not.

                                                                -

                                                                Parameters

                                                                • mode: "client" | "server"

                                                                Returns Promise<void>

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              cancelReprovidefindPeerfindProvidersgetgetClosestPeersgetModeprovideputrefreshRoutingTablesetMode
                                                              \ No newline at end of file +

                                                              Parameters

                                                              • mode: "client" | "server"

                                                              Returns Promise<void>

                                                              Settings

                                                              Member Visibility

                                                              Theme

                                                              On This Page

                                                              cancelReprovidefindPeerfindProvidersgetgetClosestPeersgetModeprovideputrefreshRoutingTablesetMode
                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.KadDHTComponents.html b/interfaces/_libp2p_kad_dht.KadDHTComponents.html index 2a95385445..082170e871 100644 --- a/interfaces/_libp2p_kad_dht.KadDHTComponents.html +++ b/interfaces/_libp2p_kad_dht.KadDHTComponents.html @@ -1,4 +1,4 @@ -KadDHTComponents | libp2p

                                                              Interface KadDHTComponents

                                                              interface KadDHTComponents {
                                                                  addressManager: AddressManager;
                                                                  connectionManager: ConnectionManager;
                                                                  datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                  events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                                  logger: ComponentLogger;
                                                                  metrics?: Metrics;
                                                                  peerId: PeerId;
                                                                  peerStore: PeerStore;
                                                                  privateKey: PrivateKey;
                                                                  registrar: Registrar;
                                                              }

                                                              Properties

                                                              addressManager +KadDHTComponents | libp2p

                                                              Interface KadDHTComponents

                                                              interface KadDHTComponents {
                                                                  addressManager: AddressManager;
                                                                  connectionManager: ConnectionManager;
                                                                  datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                  events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                                  logger: ComponentLogger;
                                                                  metrics?: Metrics;
                                                                  peerId: PeerId;
                                                                  peerStore: PeerStore;
                                                                  privateKey: PrivateKey;
                                                                  registrar: Registrar;
                                                              }

                                                              Properties

                                                              addressManager connectionManager datastore events @@ -8,4 +8,4 @@ peerStore privateKey registrar -

                                                              Properties

                                                              addressManager

                                                              addressManager: AddressManager

                                                              connectionManager

                                                              connectionManager: ConnectionManager

                                                              datastore

                                                              datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                              Type declaration

                                                                Type declaration

                                                                  Type declaration

                                                                    Type declaration

                                                                      Type declaration

                                                                        Type declaration

                                                                          Type declaration

                                                                            Type declaration

                                                                              Type declaration

                                                                                Type declaration

                                                                                  events

                                                                                  events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                                                                  logger

                                                                                  logger: ComponentLogger

                                                                                  Optional metrics

                                                                                  metrics?: Metrics

                                                                                  peerId

                                                                                  peerId: PeerId

                                                                                  peerStore

                                                                                  peerStore: PeerStore

                                                                                  privateKey

                                                                                  privateKey: PrivateKey

                                                                                  registrar

                                                                                  registrar: Registrar

                                                                                  Settings

                                                                                  Member Visibility

                                                                                  Theme

                                                                                  On This Page

                                                                                  addressManagerconnectionManagerdatastoreeventsloggermetricspeerIdpeerStoreprivateKeyregistrar
                                                                                  \ No newline at end of file +

                                                                                  Properties

                                                                                  addressManager

                                                                                  addressManager: AddressManager

                                                                                  connectionManager

                                                                                  connectionManager: ConnectionManager

                                                                                  datastore

                                                                                  datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                  Type declaration

                                                                                    Type declaration

                                                                                      Type declaration

                                                                                        Type declaration

                                                                                          Type declaration

                                                                                            Type declaration

                                                                                              Type declaration

                                                                                                Type declaration

                                                                                                  Type declaration

                                                                                                    Type declaration

                                                                                                      events

                                                                                                      events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                                                                                      logger

                                                                                                      logger: ComponentLogger

                                                                                                      Optional metrics

                                                                                                      metrics?: Metrics

                                                                                                      peerId

                                                                                                      peerId: PeerId

                                                                                                      peerStore

                                                                                                      peerStore: PeerStore

                                                                                                      privateKey

                                                                                                      privateKey: PrivateKey

                                                                                                      registrar

                                                                                                      registrar: Registrar

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      addressManagerconnectionManagerdatastoreeventsloggermetricspeerIdpeerStoreprivateKeyregistrar
                                                                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.KadDHTInit.html b/interfaces/_libp2p_kad_dht.KadDHTInit.html index 9f233237da..5f95f42ef1 100644 --- a/interfaces/_libp2p_kad_dht.KadDHTInit.html +++ b/interfaces/_libp2p_kad_dht.KadDHTInit.html @@ -1,4 +1,4 @@ -KadDHTInit | libp2p

                                                                                                      Interface KadDHTInit

                                                                                                      interface KadDHTInit {
                                                                                                          allowQueryWithZeroPeers?: boolean;
                                                                                                          clientMode?: boolean;
                                                                                                          datastorePrefix?: string;
                                                                                                          initialQuerySelfInterval?: number;
                                                                                                          kBucketSize?: number;
                                                                                                          kBucketSplitThreshold?: number;
                                                                                                          logPrefix?: string;
                                                                                                          maxInboundStreams?: number;
                                                                                                          maxOutboundStreams?: number;
                                                                                                          metricsPrefix?: string;
                                                                                                          networkDialTimeout?: Omit<AdaptiveTimeoutInit, "metricsName" | "metrics">;
                                                                                                          pingNewContactConcurrency?: number;
                                                                                                          pingNewContactMaxQueueSize?: number;
                                                                                                          pingNewContactTimeout?: Omit<AdaptiveTimeoutInit, "metricsName" | "metrics">;
                                                                                                          pingOldContactConcurrency?: number;
                                                                                                          pingOldContactMaxQueueSize?: number;
                                                                                                          pingOldContactTimeout?: Omit<AdaptiveTimeoutInit, "metricsName" | "metrics">;
                                                                                                          prefixLength?: number;
                                                                                                          protocol?: string;
                                                                                                          providers?: ProvidersInit;
                                                                                                          querySelfInterval?: number;
                                                                                                          reprovide?: ReProvideInit;
                                                                                                          selectors?: Selectors;
                                                                                                          validators?: Validators;
                                                                                                          peerInfoMapper?(peer): PeerInfo;
                                                                                                      }

                                                                                                      Properties

                                                                                                      allowQueryWithZeroPeers? +KadDHTInit | libp2p

                                                                                                      Interface KadDHTInit

                                                                                                      interface KadDHTInit {
                                                                                                          allowQueryWithZeroPeers?: boolean;
                                                                                                          clientMode?: boolean;
                                                                                                          datastorePrefix?: string;
                                                                                                          initialQuerySelfInterval?: number;
                                                                                                          kBucketSize?: number;
                                                                                                          kBucketSplitThreshold?: number;
                                                                                                          logPrefix?: string;
                                                                                                          maxInboundStreams?: number;
                                                                                                          maxOutboundStreams?: number;
                                                                                                          metricsPrefix?: string;
                                                                                                          networkDialTimeout?: Omit<AdaptiveTimeoutInit, "metricsName" | "metrics">;
                                                                                                          pingNewContactConcurrency?: number;
                                                                                                          pingNewContactMaxQueueSize?: number;
                                                                                                          pingNewContactTimeout?: Omit<AdaptiveTimeoutInit, "metricsName" | "metrics">;
                                                                                                          pingOldContactConcurrency?: number;
                                                                                                          pingOldContactMaxQueueSize?: number;
                                                                                                          pingOldContactTimeout?: Omit<AdaptiveTimeoutInit, "metricsName" | "metrics">;
                                                                                                          prefixLength?: number;
                                                                                                          protocol?: string;
                                                                                                          providers?: ProvidersInit;
                                                                                                          querySelfInterval?: number;
                                                                                                          reprovide?: ReProvideInit;
                                                                                                          selectors?: Selectors;
                                                                                                          validators?: Validators;
                                                                                                          peerInfoMapper?(peer): PeerInfo;
                                                                                                      }

                                                                                                      Properties

                                                                                                      allowQueryWithZeroPeers? clientMode? datastorePrefix? initialQuerySelfInterval? @@ -28,65 +28,65 @@

                                                                                                      Pass true here to disable this behaviour.

                                                                                                      Default

                                                                                                      false
                                                                                                      -

                                                                                                      Optional clientMode

                                                                                                      clientMode?: boolean

                                                                                                      If true, only ever be a DHT client. If false, be a DHT client until told +

                                                                                                      Optional clientMode

                                                                                                      clientMode?: boolean

                                                                                                      If true, only ever be a DHT client. If false, be a DHT client until told to be a DHT server via setMode.

                                                                                                      Default

                                                                                                      false
                                                                                                      -

                                                                                                      Optional datastorePrefix

                                                                                                      datastorePrefix?: string

                                                                                                      The datastore prefix to use

                                                                                                      +

                                                                                                      Optional datastorePrefix

                                                                                                      datastorePrefix?: string

                                                                                                      The datastore prefix to use

                                                                                                      Default

                                                                                                      "/dht"
                                                                                                      -

                                                                                                      Optional initialQuerySelfInterval

                                                                                                      initialQuerySelfInterval?: number

                                                                                                      During startup we run the self-query at a shorter interval to ensure +

                                                                                                      Optional initialQuerySelfInterval

                                                                                                      initialQuerySelfInterval?: number

                                                                                                      During startup we run the self-query at a shorter interval to ensure the containing node can respond to queries quickly. Set this interval here in ms.

                                                                                                      Default

                                                                                                      1000
                                                                                                      -

                                                                                                      Optional kBucketSize

                                                                                                      kBucketSize?: number

                                                                                                      How many peers to store in each kBucket. Once there are more than this +

                                                                                                      Optional kBucketSize

                                                                                                      kBucketSize?: number

                                                                                                      How many peers to store in each kBucket. Once there are more than this number of peers for a given prefix in a kBucket, the node will start to ping existing peers to see if they are still online - if they are offline they will be evicted and the new peer added.

                                                                                                      Default

                                                                                                      20
                                                                                                      -

                                                                                                      Optional kBucketSplitThreshold

                                                                                                      kBucketSplitThreshold?: number

                                                                                                      The threshold at which a kBucket will be split into two smaller kBuckets.

                                                                                                      +

                                                                                                      Optional kBucketSplitThreshold

                                                                                                      kBucketSplitThreshold?: number

                                                                                                      The threshold at which a kBucket will be split into two smaller kBuckets.

                                                                                                      KBuckets will not be split once the maximum trie depth is reached (controlled by the prefixLength option) so one can replicate go-libp2p's accelerated DHT client by (for example) setting kBucketSize to Infinity and kBucketSplitThreshold to 20.

                                                                                                      Default

                                                                                                      kBucketSize
                                                                                                      -

                                                                                                      Optional logPrefix

                                                                                                      logPrefix?: string

                                                                                                      The logging prefix to use

                                                                                                      +

                                                                                                      Optional logPrefix

                                                                                                      logPrefix?: string

                                                                                                      The logging prefix to use

                                                                                                      Default

                                                                                                      "libp2p:kad-dht"
                                                                                                      -

                                                                                                      Optional maxInboundStreams

                                                                                                      maxInboundStreams?: number

                                                                                                      How many parallel incoming streams to allow on the DHT protocol per +

                                                                                                      Optional maxInboundStreams

                                                                                                      maxInboundStreams?: number

                                                                                                      How many parallel incoming streams to allow on the DHT protocol per connection

                                                                                                      Default

                                                                                                      32
                                                                                                      -

                                                                                                      Optional maxOutboundStreams

                                                                                                      maxOutboundStreams?: number

                                                                                                      How many parallel outgoing streams to allow on the DHT protocol per +

                                                                                                      Optional maxOutboundStreams

                                                                                                      maxOutboundStreams?: number

                                                                                                      How many parallel outgoing streams to allow on the DHT protocol per connection

                                                                                                      Default

                                                                                                      64
                                                                                                      -

                                                                                                      Optional metricsPrefix

                                                                                                      metricsPrefix?: string

                                                                                                      The metrics prefix to use

                                                                                                      +

                                                                                                      Optional metricsPrefix

                                                                                                      metricsPrefix?: string

                                                                                                      The metrics prefix to use

                                                                                                      Default

                                                                                                      "libp2p_kad_dht"
                                                                                                      -

                                                                                                      Optional networkDialTimeout

                                                                                                      networkDialTimeout?: Omit<AdaptiveTimeoutInit, "metricsName" | "metrics">

                                                                                                      Dynamic network timeout settings for sending messages to peers

                                                                                                      -

                                                                                                      Optional pingNewContactConcurrency

                                                                                                      pingNewContactConcurrency?: number

                                                                                                      How many peers to ping in parallel when deciding if they should be added to +

                                                                                                      Optional networkDialTimeout

                                                                                                      networkDialTimeout?: Omit<AdaptiveTimeoutInit, "metricsName" | "metrics">

                                                                                                      Dynamic network timeout settings for sending messages to peers

                                                                                                      +

                                                                                                      Optional pingNewContactConcurrency

                                                                                                      pingNewContactConcurrency?: number

                                                                                                      How many peers to ping in parallel when deciding if they should be added to the routing table or not

                                                                                                      Default

                                                                                                      10
                                                                                                      -

                                                                                                      Optional pingNewContactMaxQueueSize

                                                                                                      pingNewContactMaxQueueSize?: number

                                                                                                      How long the queue to ping peers is allowed to grow

                                                                                                      +

                                                                                                      Optional pingNewContactMaxQueueSize

                                                                                                      pingNewContactMaxQueueSize?: number

                                                                                                      How long the queue to ping peers is allowed to grow

                                                                                                      Default

                                                                                                      100
                                                                                                      -

                                                                                                      Optional pingNewContactTimeout

                                                                                                      pingNewContactTimeout?: Omit<AdaptiveTimeoutInit, "metricsName" | "metrics">

                                                                                                      Settings for how long to wait in ms when pinging DHT peers to decide if +

                                                                                                      Optional pingNewContactTimeout

                                                                                                      pingNewContactTimeout?: Omit<AdaptiveTimeoutInit, "metricsName" | "metrics">

                                                                                                      Settings for how long to wait in ms when pinging DHT peers to decide if they should be added to the routing table or not.

                                                                                                      -

                                                                                                      Optional pingOldContactConcurrency

                                                                                                      pingOldContactConcurrency?: number

                                                                                                      How many peers to ping in parallel when deciding if they should +

                                                                                                      Optional pingOldContactConcurrency

                                                                                                      pingOldContactConcurrency?: number

                                                                                                      How many peers to ping in parallel when deciding if they should be evicted from the routing table or not

                                                                                                      Default

                                                                                                      10
                                                                                                      -

                                                                                                      Optional pingOldContactMaxQueueSize

                                                                                                      pingOldContactMaxQueueSize?: number

                                                                                                      How long the queue to ping peers is allowed to grow

                                                                                                      +

                                                                                                      Optional pingOldContactMaxQueueSize

                                                                                                      pingOldContactMaxQueueSize?: number

                                                                                                      How long the queue to ping peers is allowed to grow

                                                                                                      Default

                                                                                                      100
                                                                                                      -

                                                                                                      Optional pingOldContactTimeout

                                                                                                      pingOldContactTimeout?: Omit<AdaptiveTimeoutInit, "metricsName" | "metrics">

                                                                                                      Settings for how long to wait in ms when pinging DHT peers to decide if +

                                                                                                      Optional pingOldContactTimeout

                                                                                                      pingOldContactTimeout?: Omit<AdaptiveTimeoutInit, "metricsName" | "metrics">

                                                                                                      Settings for how long to wait in ms when pinging DHT peers to decide if they should be evicted from the routing table or not.

                                                                                                      -

                                                                                                      Optional prefixLength

                                                                                                      prefixLength?: number

                                                                                                      How many bits of the KAD-ID of peers to use when creating the routing +

                                                                                                      Optional prefixLength

                                                                                                      prefixLength?: number

                                                                                                      How many bits of the KAD-ID of peers to use when creating the routing table.

                                                                                                      The routing table is a binary trie with peers stored in the leaf nodes. The larger this number gets, the taller the trie can grow and the more peers @@ -95,15 +95,15 @@ to locate a certain peer, but also that more memory is consumed.

                                                                                                      Default

                                                                                                      32
                                                                                                      -

                                                                                                      Optional protocol

                                                                                                      protocol?: string

                                                                                                      The network protocol to use

                                                                                                      +

                                                                                                      Optional protocol

                                                                                                      protocol?: string

                                                                                                      The network protocol to use

                                                                                                      Default

                                                                                                      "/ipfs/kad/1.0.0"
                                                                                                      -

                                                                                                      Optional providers

                                                                                                      providers?: ProvidersInit

                                                                                                      Initialization options for the Providers component

                                                                                                      -

                                                                                                      Optional querySelfInterval

                                                                                                      querySelfInterval?: number

                                                                                                      How often to query our own PeerId in order to ensure we have a +

                                                                                                      Optional providers

                                                                                                      providers?: ProvidersInit

                                                                                                      Initialization options for the Providers component

                                                                                                      +

                                                                                                      Optional querySelfInterval

                                                                                                      querySelfInterval?: number

                                                                                                      How often to query our own PeerId in order to ensure we have a good view on the KAD address space local to our PeerId

                                                                                                      -

                                                                                                      Optional reprovide

                                                                                                      reprovide?: ReProvideInit

                                                                                                      Initialization options for the Reprovider component

                                                                                                      -

                                                                                                      Optional selectors

                                                                                                      selectors?: Selectors

                                                                                                      Record selectors

                                                                                                      -

                                                                                                      Optional validators

                                                                                                      validators?: Validators

                                                                                                      Record validators

                                                                                                      -

                                                                                                      Methods

                                                                                                      Optional peerInfoMapper

                                                                                                      Optional reprovide

                                                                                                      reprovide?: ReProvideInit

                                                                                                      Initialization options for the Reprovider component

                                                                                                      +

                                                                                                      Optional selectors

                                                                                                      selectors?: Selectors

                                                                                                      Record selectors

                                                                                                      +

                                                                                                      Optional validators

                                                                                                      validators?: Validators

                                                                                                      Record validators

                                                                                                      +

                                                                                                      Methods

                                                                                                      Optional peerInfoMapper

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      allowQueryWithZeroPeersclientModedatastorePrefixinitialQuerySelfIntervalkBucketSizekBucketSplitThresholdlogPrefixmaxInboundStreamsmaxOutboundStreamsmetricsPrefixnetworkDialTimeoutpingNewContactConcurrencypingNewContactMaxQueueSizepingNewContactTimeoutpingOldContactConcurrencypingOldContactMaxQueueSizepingOldContactTimeoutprefixLengthprotocolprovidersquerySelfIntervalreprovideselectorsvalidatorspeerInfoMapper
                                                                                                      \ No newline at end of file +

                                                                                                      Parameters

                                                                                                      Returns PeerInfo

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      allowQueryWithZeroPeersclientModedatastorePrefixinitialQuerySelfIntervalkBucketSizekBucketSplitThresholdlogPrefixmaxInboundStreamsmaxOutboundStreamsmetricsPrefixnetworkDialTimeoutpingNewContactConcurrencypingNewContactMaxQueueSizepingNewContactTimeoutpingOldContactConcurrencypingOldContactMaxQueueSizepingOldContactTimeoutprefixLengthprotocolprovidersquerySelfIntervalreprovideselectorsvalidatorspeerInfoMapper
                                                                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.PeerInfoMapper.html b/interfaces/_libp2p_kad_dht.PeerInfoMapper.html index 21d1954627..167226efb7 100644 --- a/interfaces/_libp2p_kad_dht.PeerInfoMapper.html +++ b/interfaces/_libp2p_kad_dht.PeerInfoMapper.html @@ -1 +1 @@ -PeerInfoMapper | libp2p

                                                                                                      Interface PeerInfoMapper

                                                                                                      interface PeerInfoMapper ((peer) => PeerInfo)

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      \ No newline at end of file +PeerInfoMapper | libp2p

                                                                                                      Interface PeerInfoMapper

                                                                                                      interface PeerInfoMapper ((peer) => PeerInfo)

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.PeerResponseEvent.html b/interfaces/_libp2p_kad_dht.PeerResponseEvent.html index 51f458464c..b6f2904bb4 100644 --- a/interfaces/_libp2p_kad_dht.PeerResponseEvent.html +++ b/interfaces/_libp2p_kad_dht.PeerResponseEvent.html @@ -1,6 +1,6 @@ PeerResponseEvent | libp2p

                                                                                                      Interface PeerResponseEvent

                                                                                                      Emitted when query responses are received form remote peers. Depending on the query these events may be followed by a FinalPeerEvent, a ValueEvent or a ProviderEvent.

                                                                                                      -
                                                                                                      interface PeerResponseEvent {
                                                                                                          closer: PeerInfo[];
                                                                                                          from: PeerId;
                                                                                                          messageName: "PUT_VALUE" | "GET_VALUE" | "ADD_PROVIDER" | "GET_PROVIDERS" | "FIND_NODE" | "PING" | "codec";
                                                                                                          messageType: MessageType;
                                                                                                          name: "PEER_RESPONSE";
                                                                                                          providers: PeerInfo[];
                                                                                                          record?: DHTRecord;
                                                                                                          type: PEER_RESPONSE;
                                                                                                      }

                                                                                                      Properties

                                                                                                      closer +
                                                                                                      interface PeerResponseEvent {
                                                                                                          closer: PeerInfo[];
                                                                                                          from: PeerId;
                                                                                                          messageName: "PUT_VALUE" | "GET_VALUE" | "ADD_PROVIDER" | "GET_PROVIDERS" | "FIND_NODE" | "PING" | "codec";
                                                                                                          messageType: MessageType;
                                                                                                          name: "PEER_RESPONSE";
                                                                                                          providers: PeerInfo[];
                                                                                                          record?: DHTRecord;
                                                                                                          type: PEER_RESPONSE;
                                                                                                      }

                                                                                                      Properties

                                                                                                      closer from messageName messageType @@ -8,4 +8,4 @@ providers record? type -

                                                                                                      Properties

                                                                                                      closer

                                                                                                      closer: PeerInfo[]

                                                                                                      from

                                                                                                      from: PeerId

                                                                                                      messageName

                                                                                                      messageName: "PUT_VALUE" | "GET_VALUE" | "ADD_PROVIDER" | "GET_PROVIDERS" | "FIND_NODE" | "PING" | "codec"

                                                                                                      messageType

                                                                                                      messageType: MessageType

                                                                                                      name

                                                                                                      name: "PEER_RESPONSE"

                                                                                                      providers

                                                                                                      providers: PeerInfo[]

                                                                                                      Optional record

                                                                                                      record?: DHTRecord

                                                                                                      type

                                                                                                      type: PEER_RESPONSE

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      closerfrommessageNamemessageTypenameprovidersrecordtype
                                                                                                      \ No newline at end of file +

                                                                                                      Properties

                                                                                                      closer

                                                                                                      closer: PeerInfo[]

                                                                                                      from

                                                                                                      from: PeerId

                                                                                                      messageName

                                                                                                      messageName: "PUT_VALUE" | "GET_VALUE" | "ADD_PROVIDER" | "GET_PROVIDERS" | "FIND_NODE" | "PING" | "codec"

                                                                                                      messageType

                                                                                                      messageType: MessageType

                                                                                                      name

                                                                                                      name: "PEER_RESPONSE"

                                                                                                      providers

                                                                                                      providers: PeerInfo[]

                                                                                                      Optional record

                                                                                                      record?: DHTRecord

                                                                                                      type

                                                                                                      type: PEER_RESPONSE

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      closerfrommessageNamemessageTypenameprovidersrecordtype
                                                                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.ProviderEvent.html b/interfaces/_libp2p_kad_dht.ProviderEvent.html index e49606af8d..bf645806bf 100644 --- a/interfaces/_libp2p_kad_dht.ProviderEvent.html +++ b/interfaces/_libp2p_kad_dht.ProviderEvent.html @@ -1,6 +1,6 @@ ProviderEvent | libp2p

                                                                                                      Interface ProviderEvent

                                                                                                      Emitted when providers are found

                                                                                                      -
                                                                                                      interface ProviderEvent {
                                                                                                          from: PeerId;
                                                                                                          name: "PROVIDER";
                                                                                                          providers: PeerInfo[];
                                                                                                          type: PROVIDER;
                                                                                                      }

                                                                                                      Properties

                                                                                                      from +
                                                                                                      interface ProviderEvent {
                                                                                                          from: PeerId;
                                                                                                          name: "PROVIDER";
                                                                                                          providers: PeerInfo[];
                                                                                                          type: PROVIDER;
                                                                                                      }

                                                                                                      Properties

                                                                                                      from name providers type -

                                                                                                      Properties

                                                                                                      from

                                                                                                      from: PeerId

                                                                                                      name

                                                                                                      name: "PROVIDER"

                                                                                                      providers

                                                                                                      providers: PeerInfo[]

                                                                                                      type

                                                                                                      type: PROVIDER

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      fromnameproviderstype
                                                                                                      \ No newline at end of file +

                                                                                                      Properties

                                                                                                      from

                                                                                                      from: PeerId

                                                                                                      name

                                                                                                      name: "PROVIDER"

                                                                                                      providers

                                                                                                      providers: PeerInfo[]

                                                                                                      type

                                                                                                      type: PROVIDER

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      fromnameproviderstype
                                                                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.ProvidersInit.html b/interfaces/_libp2p_kad_dht.ProvidersInit.html index 66ad55ba0e..009202668a 100644 --- a/interfaces/_libp2p_kad_dht.ProvidersInit.html +++ b/interfaces/_libp2p_kad_dht.ProvidersInit.html @@ -1,12 +1,12 @@ -ProvidersInit | libp2p

                                                                                                      Interface ProvidersInit

                                                                                                      interface ProvidersInit {
                                                                                                          cacheSize?: number;
                                                                                                          cleanupInterval?: number;
                                                                                                          provideValidity?: number;
                                                                                                      }

                                                                                                      Properties

                                                                                                      cacheSize? +ProvidersInit | libp2p

                                                                                                      Interface ProvidersInit

                                                                                                      interface ProvidersInit {
                                                                                                          cacheSize?: number;
                                                                                                          cleanupInterval?: number;
                                                                                                          provideValidity?: number;
                                                                                                      }

                                                                                                      Properties

                                                                                                      cacheSize? cleanupInterval? provideValidity?

                                                                                                      Properties

                                                                                                      Optional cacheSize

                                                                                                      cacheSize?: number

                                                                                                      Default

                                                                                                      256
                                                                                                      -

                                                                                                      Optional cleanupInterval

                                                                                                      cleanupInterval?: number

                                                                                                      How often invalid records are cleaned in seconds

                                                                                                      +

                                                                                                      Optional cleanupInterval

                                                                                                      cleanupInterval?: number

                                                                                                      How often invalid records are cleaned in seconds

                                                                                                      Default

                                                                                                      5_400
                                                                                                      -

                                                                                                      Optional provideValidity

                                                                                                      provideValidity?: number

                                                                                                      How long is a provider valid for in seconds

                                                                                                      +

                                                                                                      Optional provideValidity

                                                                                                      provideValidity?: number

                                                                                                      How long is a provider valid for in seconds

                                                                                                      Default

                                                                                                      86_400
                                                                                                      -

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      cacheSizecleanupIntervalprovideValidity
                                                                                                      \ No newline at end of file +

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      cacheSizecleanupIntervalprovideValidity
                                                                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.QueryErrorEvent.html b/interfaces/_libp2p_kad_dht.QueryErrorEvent.html index 58261875c1..ec20b46c39 100644 --- a/interfaces/_libp2p_kad_dht.QueryErrorEvent.html +++ b/interfaces/_libp2p_kad_dht.QueryErrorEvent.html @@ -1,6 +1,6 @@ QueryErrorEvent | libp2p

                                                                                                      Interface QueryErrorEvent

                                                                                                      Something went wrong with the query

                                                                                                      -
                                                                                                      interface QueryErrorEvent {
                                                                                                          error: Error;
                                                                                                          from: PeerId;
                                                                                                          name: "QUERY_ERROR";
                                                                                                          type: QUERY_ERROR;
                                                                                                      }

                                                                                                      Properties

                                                                                                      error +
                                                                                                      interface QueryErrorEvent {
                                                                                                          error: Error;
                                                                                                          from: PeerId;
                                                                                                          name: "QUERY_ERROR";
                                                                                                          type: QUERY_ERROR;
                                                                                                      }

                                                                                                      Properties

                                                                                                      error from name type -

                                                                                                      Properties

                                                                                                      error

                                                                                                      error: Error

                                                                                                      from

                                                                                                      from: PeerId

                                                                                                      name

                                                                                                      name: "QUERY_ERROR"

                                                                                                      type

                                                                                                      type: QUERY_ERROR

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      errorfromnametype
                                                                                                      \ No newline at end of file +

                                                                                                      Properties

                                                                                                      error

                                                                                                      error: Error

                                                                                                      from

                                                                                                      from: PeerId

                                                                                                      name

                                                                                                      name: "QUERY_ERROR"

                                                                                                      type

                                                                                                      type: QUERY_ERROR

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      errorfromnametype
                                                                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.ReProvideInit.html b/interfaces/_libp2p_kad_dht.ReProvideInit.html index 348302f3af..e4b3fec257 100644 --- a/interfaces/_libp2p_kad_dht.ReProvideInit.html +++ b/interfaces/_libp2p_kad_dht.ReProvideInit.html @@ -1,4 +1,4 @@ -ReProvideInit | libp2p

                                                                                                      Interface ReProvideInit

                                                                                                      interface ReProvideInit {
                                                                                                          concurrency?: number;
                                                                                                          interval?: number;
                                                                                                          maxQueueSize?: number;
                                                                                                          threshold?: number;
                                                                                                          validity?: number;
                                                                                                      }

                                                                                                      Properties

                                                                                                      concurrency? +ReProvideInit | libp2p

                                                                                                      Interface ReProvideInit

                                                                                                      interface ReProvideInit {
                                                                                                          concurrency?: number;
                                                                                                          interval?: number;
                                                                                                          maxQueueSize?: number;
                                                                                                          threshold?: number;
                                                                                                          validity?: number;
                                                                                                      }

                                                                                                      Properties

                                                                                                      concurrency? interval? maxQueueSize? threshold? @@ -6,16 +6,16 @@

                                                                                                      Properties

                                                                                                      Optional concurrency

                                                                                                      concurrency?: number

                                                                                                      How many re-provide operations to run simultaneously

                                                                                                      Default

                                                                                                      10
                                                                                                      -

                                                                                                      Optional interval

                                                                                                      interval?: number

                                                                                                      How often to check which records need re-providing in ms

                                                                                                      +

                                                                                                      Optional interval

                                                                                                      interval?: number

                                                                                                      How often to check which records need re-providing in ms

                                                                                                      Default

                                                                                                      3_600_000 (1 hour)
                                                                                                      -

                                                                                                      Optional maxQueueSize

                                                                                                      maxQueueSize?: number

                                                                                                      How long to let the re-provide queue grow

                                                                                                      +

                                                                                                      Optional maxQueueSize

                                                                                                      maxQueueSize?: number

                                                                                                      How long to let the re-provide queue grow

                                                                                                      Default

                                                                                                      16_384
                                                                                                      -

                                                                                                      Optional threshold

                                                                                                      threshold?: number

                                                                                                      How long before the record expiry to re-provide in ms

                                                                                                      +

                                                                                                      Optional threshold

                                                                                                      threshold?: number

                                                                                                      How long before the record expiry to re-provide in ms

                                                                                                      Default

                                                                                                      86_400_000 (24 hours)
                                                                                                      -

                                                                                                      Optional validity

                                                                                                      validity?: number

                                                                                                      How long provider records are valid for in ms

                                                                                                      +

                                                                                                      Optional validity

                                                                                                      validity?: number

                                                                                                      How long provider records are valid for in ms

                                                                                                      Default

                                                                                                      172_800_000 (48 hours)
                                                                                                      -

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      concurrencyintervalmaxQueueSizethresholdvalidity
                                                                                                      \ No newline at end of file +

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      concurrencyintervalmaxQueueSizethresholdvalidity
                                                                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.RoutingTable.html b/interfaces/_libp2p_kad_dht.RoutingTable.html index f293e1ba00..be23f08d67 100644 --- a/interfaces/_libp2p_kad_dht.RoutingTable.html +++ b/interfaces/_libp2p_kad_dht.RoutingTable.html @@ -1,2 +1,2 @@ -RoutingTable | libp2p

                                                                                                      Interface RoutingTable

                                                                                                      interface RoutingTable {
                                                                                                          size: number;
                                                                                                      }

                                                                                                      Properties

                                                                                                      size -

                                                                                                      Properties

                                                                                                      size

                                                                                                      size: number

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      size
                                                                                                      \ No newline at end of file +RoutingTable | libp2p

                                                                                                      Interface RoutingTable

                                                                                                      interface RoutingTable {
                                                                                                          size: number;
                                                                                                      }

                                                                                                      Properties

                                                                                                      size +

                                                                                                      Properties

                                                                                                      size

                                                                                                      size: number

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      size
                                                                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.SelectFn.html b/interfaces/_libp2p_kad_dht.SelectFn.html index 78b123d327..eda0724784 100644 --- a/interfaces/_libp2p_kad_dht.SelectFn.html +++ b/interfaces/_libp2p_kad_dht.SelectFn.html @@ -1,3 +1,3 @@ SelectFn | libp2p

                                                                                                      Interface SelectFn

                                                                                                      A selector function takes a DHT key and a list of records and returns the index of the best record in the list

                                                                                                      -
                                                                                                      interface SelectFn ((key, records) => number)

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      \ No newline at end of file +
                                                                                                      interface SelectFn ((key, records) => number)

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.SendQueryEvent.html b/interfaces/_libp2p_kad_dht.SendQueryEvent.html index 5577f9ff51..ddc17967ce 100644 --- a/interfaces/_libp2p_kad_dht.SendQueryEvent.html +++ b/interfaces/_libp2p_kad_dht.SendQueryEvent.html @@ -1,7 +1,7 @@ SendQueryEvent | libp2p

                                                                                                      Interface SendQueryEvent

                                                                                                      Emitted when sending queries to remote peers

                                                                                                      -
                                                                                                      interface SendQueryEvent {
                                                                                                          messageName: "PUT_VALUE" | "GET_VALUE" | "ADD_PROVIDER" | "GET_PROVIDERS" | "FIND_NODE" | "PING" | "codec";
                                                                                                          messageType: MessageType;
                                                                                                          name: "SEND_QUERY";
                                                                                                          to: PeerId;
                                                                                                          type: SEND_QUERY;
                                                                                                      }

                                                                                                      Properties

                                                                                                      messageName +
                                                                                                      interface SendQueryEvent {
                                                                                                          messageName: "PUT_VALUE" | "GET_VALUE" | "ADD_PROVIDER" | "GET_PROVIDERS" | "FIND_NODE" | "PING" | "codec";
                                                                                                          messageType: MessageType;
                                                                                                          name: "SEND_QUERY";
                                                                                                          to: PeerId;
                                                                                                          type: SEND_QUERY;
                                                                                                      }

                                                                                                      Properties

                                                                                                      messageName messageType name to type -

                                                                                                      Properties

                                                                                                      messageName

                                                                                                      messageName: "PUT_VALUE" | "GET_VALUE" | "ADD_PROVIDER" | "GET_PROVIDERS" | "FIND_NODE" | "PING" | "codec"

                                                                                                      messageType

                                                                                                      messageType: MessageType

                                                                                                      name

                                                                                                      name: "SEND_QUERY"

                                                                                                      to

                                                                                                      to: PeerId

                                                                                                      type

                                                                                                      type: SEND_QUERY

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      messageNamemessageTypenametotype
                                                                                                      \ No newline at end of file +

                                                                                                      Properties

                                                                                                      messageName

                                                                                                      messageName: "PUT_VALUE" | "GET_VALUE" | "ADD_PROVIDER" | "GET_PROVIDERS" | "FIND_NODE" | "PING" | "codec"

                                                                                                      messageType

                                                                                                      messageType: MessageType

                                                                                                      name

                                                                                                      name: "SEND_QUERY"

                                                                                                      to

                                                                                                      to: PeerId

                                                                                                      type

                                                                                                      type: SEND_QUERY

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      messageNamemessageTypenametotype
                                                                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.SingleKadDHT.html b/interfaces/_libp2p_kad_dht.SingleKadDHT.html index 94b3c2f701..41822d6d94 100644 --- a/interfaces/_libp2p_kad_dht.SingleKadDHT.html +++ b/interfaces/_libp2p_kad_dht.SingleKadDHT.html @@ -1,4 +1,4 @@ -SingleKadDHT | libp2p

                                                                                                      Interface SingleKadDHT

                                                                                                      interface SingleKadDHT {
                                                                                                          routingTable: RoutingTable;
                                                                                                          cancelReprovide(key): Promise<void>;
                                                                                                          findPeer(id, options?): AsyncIterable<QueryEvent>;
                                                                                                          findProviders(key, options?): AsyncIterable<QueryEvent>;
                                                                                                          get(key, options?): AsyncIterable<QueryEvent>;
                                                                                                          getClosestPeers(key, options?): AsyncIterable<QueryEvent>;
                                                                                                          getMode(): "client" | "server";
                                                                                                          provide(key, options?): AsyncIterable<QueryEvent>;
                                                                                                          put(key, value, options?): AsyncIterable<QueryEvent>;
                                                                                                          refreshRoutingTable(): Promise<void>;
                                                                                                          setMode(mode): Promise<void>;
                                                                                                      }

                                                                                                      Hierarchy (view full)

                                                                                                      Properties

                                                                                                      routingTable +SingleKadDHT | libp2p

                                                                                                      Interface SingleKadDHT

                                                                                                      interface SingleKadDHT {
                                                                                                          routingTable: RoutingTable;
                                                                                                          cancelReprovide(key): Promise<void>;
                                                                                                          findPeer(id, options?): AsyncIterable<QueryEvent>;
                                                                                                          findProviders(key, options?): AsyncIterable<QueryEvent>;
                                                                                                          get(key, options?): AsyncIterable<QueryEvent>;
                                                                                                          getClosestPeers(key, options?): AsyncIterable<QueryEvent>;
                                                                                                          getMode(): "client" | "server";
                                                                                                          provide(key, options?): AsyncIterable<QueryEvent>;
                                                                                                          put(key, value, options?): AsyncIterable<QueryEvent>;
                                                                                                          refreshRoutingTable(): Promise<void>;
                                                                                                          setMode(mode): Promise<void>;
                                                                                                      }

                                                                                                      Hierarchy (view full)

                                                                                                      Properties

                                                                                                      routingTable

                                                                                                      Methods

                                                                                                      cancelReprovide findPeer findProviders @@ -9,16 +9,16 @@ put refreshRoutingTable setMode -

                                                                                                      Properties

                                                                                                      routingTable

                                                                                                      routingTable: RoutingTable

                                                                                                      Methods

                                                                                                      cancelReprovide

                                                                                                      • cancelReprovide(key): Promise<void>

                                                                                                      • Provider records must be re-published every 24 hours - pass a previously +

                                                                                                      Properties

                                                                                                      routingTable

                                                                                                      routingTable: RoutingTable

                                                                                                      Methods

                                                                                                      cancelReprovide

                                                                                                      findPeer

                                                                                                      findProviders

                                                                                                      get

                                                                                                      getClosestPeers

                                                                                                      getMode

                                                                                                      provide

                                                                                                      put

                                                                                                      refreshRoutingTable

                                                                                                      setMode

                                                                                                      findPeer

                                                                                                      findProviders

                                                                                                      get

                                                                                                      getClosestPeers

                                                                                                      getMode

                                                                                                      provide

                                                                                                      put

                                                                                                      refreshRoutingTable

                                                                                                      setMode

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      routingTablecancelReprovidefindPeerfindProvidersgetgetClosestPeersgetModeprovideputrefreshRoutingTablesetMode
                                                                                                      \ No newline at end of file +

                                                                                                      Parameters

                                                                                                      Returns Promise<void>

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      routingTablecancelReprovidefindPeerfindProvidersgetgetClosestPeersgetModeprovideputrefreshRoutingTablesetMode
                                                                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.ValidateFn.html b/interfaces/_libp2p_kad_dht.ValidateFn.html index 4cdd25718a..0ac954ee8f 100644 --- a/interfaces/_libp2p_kad_dht.ValidateFn.html +++ b/interfaces/_libp2p_kad_dht.ValidateFn.html @@ -1,3 +1,3 @@ ValidateFn | libp2p

                                                                                                      Interface ValidateFn

                                                                                                      A validator function takes a DHT key and the value of the record for that key and throws if the record is invalid

                                                                                                      -
                                                                                                      interface ValidateFn ((key, value) => Promise<void>)

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      \ No newline at end of file +
                                                                                                      interface ValidateFn ((key, value) => Promise<void>)

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.ValueEvent.html b/interfaces/_libp2p_kad_dht.ValueEvent.html index 2831220bd1..f7319ecf7c 100644 --- a/interfaces/_libp2p_kad_dht.ValueEvent.html +++ b/interfaces/_libp2p_kad_dht.ValueEvent.html @@ -1,6 +1,6 @@ ValueEvent | libp2p

                                                                                                      Interface ValueEvent

                                                                                                      Emitted when values are found

                                                                                                      -
                                                                                                      interface ValueEvent {
                                                                                                          from: PeerId;
                                                                                                          name: "VALUE";
                                                                                                          type: VALUE;
                                                                                                          value: Uint8Array;
                                                                                                      }

                                                                                                      Properties

                                                                                                      from +
                                                                                                      interface ValueEvent {
                                                                                                          from: PeerId;
                                                                                                          name: "VALUE";
                                                                                                          type: VALUE;
                                                                                                          value: Uint8Array;
                                                                                                      }

                                                                                                      Properties

                                                                                                      from name type value -

                                                                                                      Properties

                                                                                                      from

                                                                                                      from: PeerId

                                                                                                      name

                                                                                                      name: "VALUE"

                                                                                                      type

                                                                                                      type: VALUE

                                                                                                      value

                                                                                                      value: Uint8Array

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      fromnametypevalue
                                                                                                      \ No newline at end of file +

                                                                                                      Properties

                                                                                                      from

                                                                                                      from: PeerId

                                                                                                      name

                                                                                                      name: "VALUE"

                                                                                                      type

                                                                                                      type: VALUE

                                                                                                      value

                                                                                                      value: Uint8Array

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      fromnametypevalue
                                                                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_keychain.DEKConfig.html b/interfaces/_libp2p_keychain.DEKConfig.html index 640653fbaf..1795e480eb 100644 --- a/interfaces/_libp2p_keychain.DEKConfig.html +++ b/interfaces/_libp2p_keychain.DEKConfig.html @@ -1,5 +1,5 @@ -DEKConfig | libp2p

                                                                                                      Interface DEKConfig

                                                                                                      interface DEKConfig {
                                                                                                          hash: string;
                                                                                                          iterationCount: number;
                                                                                                          keyLength: number;
                                                                                                          salt: string;
                                                                                                      }

                                                                                                      Properties

                                                                                                      hash +DEKConfig | libp2p

                                                                                                      Interface DEKConfig

                                                                                                      interface DEKConfig {
                                                                                                          hash: string;
                                                                                                          iterationCount: number;
                                                                                                          keyLength: number;
                                                                                                          salt: string;
                                                                                                      }

                                                                                                      Properties

                                                                                                      hash iterationCount keyLength salt -

                                                                                                      Properties

                                                                                                      hash

                                                                                                      hash: string

                                                                                                      iterationCount

                                                                                                      iterationCount: number

                                                                                                      keyLength

                                                                                                      keyLength: number

                                                                                                      salt

                                                                                                      salt: string

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      hashiterationCountkeyLengthsalt
                                                                                                      \ No newline at end of file +

                                                                                                      Properties

                                                                                                      hash

                                                                                                      hash: string

                                                                                                      iterationCount

                                                                                                      iterationCount: number

                                                                                                      keyLength

                                                                                                      keyLength: number

                                                                                                      salt

                                                                                                      salt: string

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      hashiterationCountkeyLengthsalt
                                                                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_keychain.KeyInfo.html b/interfaces/_libp2p_keychain.KeyInfo.html index ea59ba010b..1c0fbb908f 100644 --- a/interfaces/_libp2p_keychain.KeyInfo.html +++ b/interfaces/_libp2p_keychain.KeyInfo.html @@ -1,5 +1,5 @@ -KeyInfo | libp2p

                                                                                                      Interface KeyInfo

                                                                                                      interface KeyInfo {
                                                                                                          id: string;
                                                                                                          name: string;
                                                                                                      }

                                                                                                      Properties

                                                                                                      id +KeyInfo | libp2p

                                                                                                      Interface KeyInfo

                                                                                                      interface KeyInfo {
                                                                                                          id: string;
                                                                                                          name: string;
                                                                                                      }

                                                                                                      Properties

                                                                                                      id name

                                                                                                      Properties

                                                                                                      id

                                                                                                      id: string

                                                                                                      The universally unique key id

                                                                                                      -

                                                                                                      name

                                                                                                      name: string

                                                                                                      The local key name

                                                                                                      -

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      idname
                                                                                                      \ No newline at end of file +

                                                                                                      name

                                                                                                      name: string

                                                                                                      The local key name

                                                                                                      +

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      idname
                                                                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_keychain.Keychain.html b/interfaces/_libp2p_keychain.Keychain.html index 508580c119..ef1226e359 100644 --- a/interfaces/_libp2p_keychain.Keychain.html +++ b/interfaces/_libp2p_keychain.Keychain.html @@ -1,4 +1,4 @@ -Keychain | libp2p

                                                                                                      Interface Keychain

                                                                                                      interface Keychain {
                                                                                                          exportKey(name): Promise<PrivateKey>;
                                                                                                          findKeyById(id): Promise<KeyInfo>;
                                                                                                          findKeyByName(name): Promise<KeyInfo>;
                                                                                                          importKey(name, key): Promise<KeyInfo>;
                                                                                                          listKeys(): Promise<KeyInfo[]>;
                                                                                                          removeKey(name): Promise<KeyInfo>;
                                                                                                          renameKey(oldName, newName): Promise<KeyInfo>;
                                                                                                          rotateKeychainPass(oldPass, newPass): Promise<void>;
                                                                                                      }

                                                                                                      Methods

                                                                                                      exportKey +Keychain | libp2p

                                                                                                      Interface Keychain

                                                                                                      interface Keychain {
                                                                                                          exportKey(name): Promise<PrivateKey>;
                                                                                                          findKeyById(id): Promise<KeyInfo>;
                                                                                                          findKeyByName(name): Promise<KeyInfo>;
                                                                                                          importKey(name, key): Promise<KeyInfo>;
                                                                                                          listKeys(): Promise<KeyInfo[]>;
                                                                                                          removeKey(name): Promise<KeyInfo>;
                                                                                                          renameKey(oldName, newName): Promise<KeyInfo>;
                                                                                                          rotateKeychainPass(oldPass, newPass): Promise<void>;
                                                                                                      }

                                                                                                      Methods

                                                                                                      exportKey findKeyById findKeyByName importKey @@ -9,26 +9,26 @@

                                                                                                      Methods

                                                                                                      exportKey

                                                                                                      • exportKey(name): Promise<PrivateKey>

                                                                                                      • Export an existing private key.

                                                                                                        Parameters

                                                                                                        • name: string

                                                                                                        Returns Promise<PrivateKey>

                                                                                                        Example

                                                                                                        import { generateKeyPair } from '@libp2p/crypto/keys'

                                                                                                        const key = await generateKeyPair('Ed25519')
                                                                                                        const keyInfo = await libp2p.keychain.importKey('my-key', key)
                                                                                                        const key = await libp2p.keychain.exportKey(keyInfo.id)
                                                                                                        -

                                                                                                      findKeyById

                                                                                                      findKeyById

                                                                                                      • findKeyById(id): Promise<KeyInfo>

                                                                                                      • Find a key by id

                                                                                                        Parameters

                                                                                                        • id: string

                                                                                                        Returns Promise<KeyInfo>

                                                                                                        Example

                                                                                                        import { generateKeyPair } from '@libp2p/crypto/keys'

                                                                                                        const key = await generateKeyPair('Ed25519')
                                                                                                        const keyInfo = await libp2p.keychain.importKey('my-key', key)
                                                                                                        const keyInfo2 = await libp2p.keychain.findKeyById(keyInfo.id)
                                                                                                        -

                                                                                                      findKeyByName

                                                                                                      findKeyByName

                                                                                                      • findKeyByName(name): Promise<KeyInfo>

                                                                                                      • Find a key by name

                                                                                                        Parameters

                                                                                                        • name: string

                                                                                                        Returns Promise<KeyInfo>

                                                                                                        Example

                                                                                                        import { generateKeyPair } from '@libp2p/crypto/keys'

                                                                                                        const key = await generateKeyPair('Ed25519')
                                                                                                        const keyInfo = await libp2p.keychain.importKey('my-key', key)
                                                                                                        const keyInfo2 = await libp2p.keychain.findKeyByName(keyInfo.name)
                                                                                                        -

                                                                                                      importKey

                                                                                                      importKey

                                                                                                      • importKey(name, key): Promise<KeyInfo>

                                                                                                      • Import a new private key.

                                                                                                        Parameters

                                                                                                        Returns Promise<KeyInfo>

                                                                                                        Example

                                                                                                        import { generateKeyPair } from '@libp2p/crypto/keys'

                                                                                                        const key = await generateKeyPair('Ed25519')
                                                                                                        const keyInfo = await libp2p.keychain.importKey('my-key', key)
                                                                                                        -

                                                                                                      listKeys

                                                                                                      listKeys

                                                                                                      removeKey

                                                                                                      removeKey

                                                                                                      • removeKey(name): Promise<KeyInfo>

                                                                                                      • Removes a key from the keychain.

                                                                                                        Parameters

                                                                                                        • name: string

                                                                                                        Returns Promise<KeyInfo>

                                                                                                        Example

                                                                                                        await libp2p.services.keychain.createKey('keyTest', 'RSA', 4096)
                                                                                                        const keyInfo = await libp2p.services.keychain.removeKey('keyTest')
                                                                                                        -

                                                                                                      renameKey

                                                                                                      • renameKey(oldName, newName): Promise<KeyInfo>

                                                                                                      • Rename a key in the keychain. This is done in a batch commit with rollback +

                                                                                                      renameKey

                                                                                                      • renameKey(oldName, newName): Promise<KeyInfo>

                                                                                                      • Rename a key in the keychain. This is done in a batch commit with rollback so errors thrown during the operation will not cause key loss.

                                                                                                        Parameters

                                                                                                        • oldName: string
                                                                                                        • newName: string

                                                                                                        Returns Promise<KeyInfo>

                                                                                                        Example

                                                                                                        await libp2p.services.keychain.createKey('keyTest', 'RSA', 4096)
                                                                                                        const keyInfo = await libp2p.services.keychain.renameKey('keyTest', 'keyNewNtest')
                                                                                                        -

                                                                                                      rotateKeychainPass

                                                                                                      • rotateKeychainPass(oldPass, newPass): Promise<void>

                                                                                                      • Rotate keychain password and re-encrypt all associated keys

                                                                                                        +

                                                                                                      rotateKeychainPass

                                                                                                      • rotateKeychainPass(oldPass, newPass): Promise<void>

                                                                                                      • Rotate keychain password and re-encrypt all associated keys

                                                                                                        Parameters

                                                                                                        • oldPass: string
                                                                                                        • newPass: string

                                                                                                        Returns Promise<void>

                                                                                                        Example

                                                                                                        await libp2p.services.keychain.rotateKeychainPass('oldPassword', 'newPassword')
                                                                                                        -

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      exportKeyfindKeyByIdfindKeyByNameimportKeylistKeysremoveKeyrenameKeyrotateKeychainPass
                                                                                                      \ No newline at end of file +

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      Theme

                                                                                                      On This Page

                                                                                                      exportKeyfindKeyByIdfindKeyByNameimportKeylistKeysremoveKeyrenameKeyrotateKeychainPass
                                                                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_keychain.KeychainComponents.html b/interfaces/_libp2p_keychain.KeychainComponents.html index a5af7c8c85..9b684e5267 100644 --- a/interfaces/_libp2p_keychain.KeychainComponents.html +++ b/interfaces/_libp2p_keychain.KeychainComponents.html @@ -1,3 +1,3 @@ -KeychainComponents | libp2p

                                                                                                      Interface KeychainComponents

                                                                                                      interface KeychainComponents {
                                                                                                          datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                          logger: ComponentLogger;
                                                                                                      }

                                                                                                      Properties

                                                                                                      datastore +KeychainComponents | libp2p

                                                                                                      Interface KeychainComponents

                                                                                                      interface KeychainComponents {
                                                                                                          datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                          logger: ComponentLogger;
                                                                                                      }

                                                                                                      Properties

                                                                                                      datastore logger -

                                                                                                      Properties

                                                                                                      datastore

                                                                                                      datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                      Type declaration

                                                                                                        Type declaration

                                                                                                          Type declaration

                                                                                                            Type declaration

                                                                                                              Type declaration

                                                                                                                Type declaration

                                                                                                                  Type declaration

                                                                                                                    Type declaration

                                                                                                                      Type declaration

                                                                                                                        Type declaration

                                                                                                                          logger

                                                                                                                          logger: ComponentLogger

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          Theme

                                                                                                                          On This Page

                                                                                                                          datastorelogger
                                                                                                                          \ No newline at end of file +

                                                                                                                          Properties

                                                                                                                          datastore

                                                                                                                          datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                          Type declaration

                                                                                                                            Type declaration

                                                                                                                              Type declaration

                                                                                                                                Type declaration

                                                                                                                                  Type declaration

                                                                                                                                    Type declaration

                                                                                                                                      Type declaration

                                                                                                                                        Type declaration

                                                                                                                                          Type declaration

                                                                                                                                            Type declaration

                                                                                                                                              logger

                                                                                                                                              logger: ComponentLogger

                                                                                                                                              Settings

                                                                                                                                              Member Visibility

                                                                                                                                              Theme

                                                                                                                                              On This Page

                                                                                                                                              datastorelogger
                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_keychain.KeychainInit.html b/interfaces/_libp2p_keychain.KeychainInit.html index d4a7d9ff16..3fb222ea04 100644 --- a/interfaces/_libp2p_keychain.KeychainInit.html +++ b/interfaces/_libp2p_keychain.KeychainInit.html @@ -1,3 +1,3 @@ -KeychainInit | libp2p

                                                                                                                                              Interface KeychainInit

                                                                                                                                              interface KeychainInit {
                                                                                                                                                  dek?: DEKConfig;
                                                                                                                                                  pass?: string;
                                                                                                                                              }

                                                                                                                                              Hierarchy

                                                                                                                                              • KeychainInit

                                                                                                                                                Properties

                                                                                                                                                dek? +KeychainInit | libp2p

                                                                                                                                                Interface KeychainInit

                                                                                                                                                interface KeychainInit {
                                                                                                                                                    dek?: DEKConfig;
                                                                                                                                                    pass?: string;
                                                                                                                                                }

                                                                                                                                                Hierarchy

                                                                                                                                                • KeychainInit

                                                                                                                                                  Properties

                                                                                                                                                  dek? pass? -

                                                                                                                                                  Properties

                                                                                                                                                  Optional dek

                                                                                                                                                  dek?: DEKConfig

                                                                                                                                                  Optional pass

                                                                                                                                                  pass?: string

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  dekpass
                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                  Properties

                                                                                                                                                  Optional dek

                                                                                                                                                  dek?: DEKConfig

                                                                                                                                                  Optional pass

                                                                                                                                                  pass?: string

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  dekpass
                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_libp2p_logger.ComponentLogger.html b/interfaces/_libp2p_logger.ComponentLogger.html index 4bae2eee7e..c8cbe58594 100644 --- a/interfaces/_libp2p_logger.ComponentLogger.html +++ b/interfaces/_libp2p_logger.ComponentLogger.html @@ -1,2 +1,2 @@ -ComponentLogger | libp2p

                                                                                                                                                  Interface ComponentLogger

                                                                                                                                                  interface ComponentLogger {
                                                                                                                                                      forComponent(name): Logger;
                                                                                                                                                  }

                                                                                                                                                  Methods

                                                                                                                                                  forComponent -

                                                                                                                                                  Methods

                                                                                                                                                  forComponent

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  forComponent
                                                                                                                                                  \ No newline at end of file +ComponentLogger | libp2p

                                                                                                                                                  Interface ComponentLogger

                                                                                                                                                  interface ComponentLogger {
                                                                                                                                                      forComponent(name): Logger;
                                                                                                                                                  }

                                                                                                                                                  Methods

                                                                                                                                                  forComponent +

                                                                                                                                                  Methods

                                                                                                                                                  forComponent

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  forComponent
                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_libp2p_logger.Logger.html b/interfaces/_libp2p_logger.Logger.html index 8172a1a2dc..ea5cd9e86b 100644 --- a/interfaces/_libp2p_logger.Logger.html +++ b/interfaces/_libp2p_logger.Logger.html @@ -1,4 +1,4 @@ -Logger | libp2p

                                                                                                                                                  Interface Logger

                                                                                                                                                  interface Logger {
                                                                                                                                                      enabled: boolean;
                                                                                                                                                      error(formatter, ...args): void;
                                                                                                                                                      trace(formatter, ...args): void;
                                                                                                                                                      (formatter, ...args): void;
                                                                                                                                                  }
                                                                                                                                                  • Logger(formatter, ...args): void

                                                                                                                                                  • Parameters

                                                                                                                                                    • formatter: any
                                                                                                                                                    • Rest ...args: any[]

                                                                                                                                                    Returns void

                                                                                                                                                  Properties

                                                                                                                                                  enabled +Logger | libp2p

                                                                                                                                                  Interface Logger

                                                                                                                                                  interface Logger {
                                                                                                                                                      enabled: boolean;
                                                                                                                                                      error(formatter, ...args): void;
                                                                                                                                                      trace(formatter, ...args): void;
                                                                                                                                                      (formatter, ...args): void;
                                                                                                                                                  }
                                                                                                                                                  • Logger(formatter, ...args): void

                                                                                                                                                  • Parameters

                                                                                                                                                    • formatter: any
                                                                                                                                                    • Rest ...args: any[]

                                                                                                                                                    Returns void

                                                                                                                                                  Properties

                                                                                                                                                  enabled

                                                                                                                                                  Methods

                                                                                                                                                  error trace -

                                                                                                                                                  Properties

                                                                                                                                                  enabled

                                                                                                                                                  enabled: boolean

                                                                                                                                                  Methods

                                                                                                                                                  error

                                                                                                                                                  • error(formatter, ...args): void

                                                                                                                                                  • Parameters

                                                                                                                                                    • formatter: any
                                                                                                                                                    • Rest ...args: any[]

                                                                                                                                                    Returns void

                                                                                                                                                  trace

                                                                                                                                                  • trace(formatter, ...args): void

                                                                                                                                                  • Parameters

                                                                                                                                                    • formatter: any
                                                                                                                                                    • Rest ...args: any[]

                                                                                                                                                    Returns void

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  enablederrortrace
                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                  Properties

                                                                                                                                                  enabled

                                                                                                                                                  enabled: boolean

                                                                                                                                                  Methods

                                                                                                                                                  error

                                                                                                                                                  • error(formatter, ...args): void

                                                                                                                                                  • Parameters

                                                                                                                                                    • formatter: any
                                                                                                                                                    • Rest ...args: any[]

                                                                                                                                                    Returns void

                                                                                                                                                  trace

                                                                                                                                                  • trace(formatter, ...args): void

                                                                                                                                                  • Parameters

                                                                                                                                                    • formatter: any
                                                                                                                                                    • Rest ...args: any[]

                                                                                                                                                    Returns void

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  enablederrortrace
                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_libp2p_logger.PeerLoggerOptions.html b/interfaces/_libp2p_logger.PeerLoggerOptions.html index 9d6c48023c..00058fee90 100644 --- a/interfaces/_libp2p_logger.PeerLoggerOptions.html +++ b/interfaces/_libp2p_logger.PeerLoggerOptions.html @@ -1,3 +1,3 @@ -PeerLoggerOptions | libp2p

                                                                                                                                                  Interface PeerLoggerOptions

                                                                                                                                                  interface PeerLoggerOptions {
                                                                                                                                                      prefixLength: number;
                                                                                                                                                      suffixLength: number;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  prefixLength +PeerLoggerOptions | libp2p

                                                                                                                                                  Interface PeerLoggerOptions

                                                                                                                                                  interface PeerLoggerOptions {
                                                                                                                                                      prefixLength: number;
                                                                                                                                                      suffixLength: number;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  prefixLength suffixLength -

                                                                                                                                                  Properties

                                                                                                                                                  prefixLength

                                                                                                                                                  prefixLength: number

                                                                                                                                                  suffixLength

                                                                                                                                                  suffixLength: number

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  prefixLengthsuffixLength
                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                  Properties

                                                                                                                                                  prefixLength

                                                                                                                                                  prefixLength: number

                                                                                                                                                  suffixLength

                                                                                                                                                  suffixLength: number

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  prefixLengthsuffixLength
                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_libp2p_mdns.MulticastDNSComponents.html b/interfaces/_libp2p_mdns.MulticastDNSComponents.html index 428f2aec8e..98956b3d71 100644 --- a/interfaces/_libp2p_mdns.MulticastDNSComponents.html +++ b/interfaces/_libp2p_mdns.MulticastDNSComponents.html @@ -1,3 +1,3 @@ -MulticastDNSComponents | libp2p

                                                                                                                                                  Interface MulticastDNSComponents

                                                                                                                                                  interface MulticastDNSComponents {
                                                                                                                                                      addressManager: AddressManager;
                                                                                                                                                      logger: ComponentLogger;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  addressManager +MulticastDNSComponents | libp2p

                                                                                                                                                  Interface MulticastDNSComponents

                                                                                                                                                  interface MulticastDNSComponents {
                                                                                                                                                      addressManager: AddressManager;
                                                                                                                                                      logger: ComponentLogger;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  addressManager logger -

                                                                                                                                                  Properties

                                                                                                                                                  addressManager

                                                                                                                                                  addressManager: AddressManager

                                                                                                                                                  logger

                                                                                                                                                  logger: ComponentLogger

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  addressManagerlogger
                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                  Properties

                                                                                                                                                  addressManager

                                                                                                                                                  addressManager: AddressManager

                                                                                                                                                  logger

                                                                                                                                                  logger: ComponentLogger

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  addressManagerlogger
                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_libp2p_mdns.MulticastDNSInit.html b/interfaces/_libp2p_mdns.MulticastDNSInit.html index eb3a33df1c..b21f5a2680 100644 --- a/interfaces/_libp2p_mdns.MulticastDNSInit.html +++ b/interfaces/_libp2p_mdns.MulticastDNSInit.html @@ -1,7 +1,7 @@ -MulticastDNSInit | libp2p

                                                                                                                                                  Interface MulticastDNSInit

                                                                                                                                                  interface MulticastDNSInit {
                                                                                                                                                      broadcast?: boolean;
                                                                                                                                                      interval?: number;
                                                                                                                                                      ip?: string;
                                                                                                                                                      peerName?: string;
                                                                                                                                                      port?: number;
                                                                                                                                                      serviceTag?: string;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  broadcast? +MulticastDNSInit | libp2p

                                                                                                                                                  Interface MulticastDNSInit

                                                                                                                                                  interface MulticastDNSInit {
                                                                                                                                                      broadcast?: boolean;
                                                                                                                                                      interval?: number;
                                                                                                                                                      ip?: string;
                                                                                                                                                      peerName?: string;
                                                                                                                                                      port?: number;
                                                                                                                                                      serviceTag?: string;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  broadcast? interval? ip? peerName? port? serviceTag? -

                                                                                                                                                  Properties

                                                                                                                                                  Optional broadcast

                                                                                                                                                  broadcast?: boolean

                                                                                                                                                  Optional interval

                                                                                                                                                  interval?: number

                                                                                                                                                  Optional ip

                                                                                                                                                  ip?: string

                                                                                                                                                  Optional peerName

                                                                                                                                                  peerName?: string

                                                                                                                                                  Optional port

                                                                                                                                                  port?: number

                                                                                                                                                  Optional serviceTag

                                                                                                                                                  serviceTag?: string

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  broadcastintervalippeerNameportserviceTag
                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                  Properties

                                                                                                                                                  Optional broadcast

                                                                                                                                                  broadcast?: boolean

                                                                                                                                                  Optional interval

                                                                                                                                                  interval?: number

                                                                                                                                                  Optional ip

                                                                                                                                                  ip?: string

                                                                                                                                                  Optional peerName

                                                                                                                                                  peerName?: string

                                                                                                                                                  Optional port

                                                                                                                                                  port?: number

                                                                                                                                                  Optional serviceTag

                                                                                                                                                  serviceTag?: string

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  broadcastintervalippeerNameportserviceTag
                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_libp2p_memory.MemoryTransportComponents.html b/interfaces/_libp2p_memory.MemoryTransportComponents.html index 0a92fd409b..3790031f0a 100644 --- a/interfaces/_libp2p_memory.MemoryTransportComponents.html +++ b/interfaces/_libp2p_memory.MemoryTransportComponents.html @@ -1,3 +1,3 @@ -MemoryTransportComponents | libp2p

                                                                                                                                                  Interface MemoryTransportComponents

                                                                                                                                                  interface MemoryTransportComponents {
                                                                                                                                                      logger: ComponentLogger;
                                                                                                                                                      peerId: PeerId;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  logger +MemoryTransportComponents | libp2p

                                                                                                                                                  Interface MemoryTransportComponents

                                                                                                                                                  interface MemoryTransportComponents {
                                                                                                                                                      logger: ComponentLogger;
                                                                                                                                                      peerId: PeerId;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  logger peerId -

                                                                                                                                                  Properties

                                                                                                                                                  logger

                                                                                                                                                  logger: ComponentLogger

                                                                                                                                                  peerId

                                                                                                                                                  peerId: PeerId

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  loggerpeerId
                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                  Properties

                                                                                                                                                  logger

                                                                                                                                                  logger: ComponentLogger

                                                                                                                                                  peerId

                                                                                                                                                  peerId: PeerId

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  loggerpeerId
                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_libp2p_memory.MemoryTransportInit.html b/interfaces/_libp2p_memory.MemoryTransportInit.html index 1fae441b3a..e7321cc2fa 100644 --- a/interfaces/_libp2p_memory.MemoryTransportInit.html +++ b/interfaces/_libp2p_memory.MemoryTransportInit.html @@ -1,7 +1,7 @@ -MemoryTransportInit | libp2p

                                                                                                                                                  Interface MemoryTransportInit

                                                                                                                                                  interface MemoryTransportInit {
                                                                                                                                                      inboundUpgradeTimeout?: number;
                                                                                                                                                      latency?: number;
                                                                                                                                                      upgraderOptions?: UpgraderOptions<ProgressEvent<any, unknown>>;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  inboundUpgradeTimeout? +MemoryTransportInit | libp2p

                                                                                                                                                  Interface MemoryTransportInit

                                                                                                                                                  interface MemoryTransportInit {
                                                                                                                                                      inboundUpgradeTimeout?: number;
                                                                                                                                                      latency?: number;
                                                                                                                                                      upgraderOptions?: UpgraderOptions<ProgressEvent<any, unknown>>;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  inboundUpgradeTimeout? latency? upgraderOptions? -

                                                                                                                                                  Properties

                                                                                                                                                  Optional inboundUpgradeTimeout

                                                                                                                                                  inboundUpgradeTimeout?: number

                                                                                                                                                  Optional latency

                                                                                                                                                  latency?: number

                                                                                                                                                  Add this much latency in ms to every buffer sent over the transport

                                                                                                                                                  +

                                                                                                                                                  Properties

                                                                                                                                                  Optional inboundUpgradeTimeout

                                                                                                                                                  inboundUpgradeTimeout?: number

                                                                                                                                                  Optional latency

                                                                                                                                                  latency?: number

                                                                                                                                                  Add this much latency in ms to every buffer sent over the transport

                                                                                                                                                  Default

                                                                                                                                                  0
                                                                                                                                                  -

                                                                                                                                                  Optional upgraderOptions

                                                                                                                                                  upgraderOptions?: UpgraderOptions<ProgressEvent<any, unknown>>

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  inboundUpgradeTimeoutlatencyupgraderOptions
                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                  Optional upgraderOptions

                                                                                                                                                  upgraderOptions?: UpgraderOptions<ProgressEvent<any, unknown>>

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  inboundUpgradeTimeoutlatencyupgraderOptions
                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_libp2p_mplex.MplexComponents.html b/interfaces/_libp2p_mplex.MplexComponents.html index 348180c53e..f9f8f6b330 100644 --- a/interfaces/_libp2p_mplex.MplexComponents.html +++ b/interfaces/_libp2p_mplex.MplexComponents.html @@ -1,2 +1,2 @@ -MplexComponents | libp2p

                                                                                                                                                  Interface MplexComponents

                                                                                                                                                  interface MplexComponents {
                                                                                                                                                      logger: ComponentLogger;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  logger -

                                                                                                                                                  Properties

                                                                                                                                                  logger

                                                                                                                                                  logger: ComponentLogger

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  logger
                                                                                                                                                  \ No newline at end of file +MplexComponents | libp2p

                                                                                                                                                  Interface MplexComponents

                                                                                                                                                  interface MplexComponents {
                                                                                                                                                      logger: ComponentLogger;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  logger +

                                                                                                                                                  Properties

                                                                                                                                                  logger

                                                                                                                                                  logger: ComponentLogger

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  logger
                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_libp2p_mplex.MplexInit.html b/interfaces/_libp2p_mplex.MplexInit.html index 300df37304..d4ad755616 100644 --- a/interfaces/_libp2p_mplex.MplexInit.html +++ b/interfaces/_libp2p_mplex.MplexInit.html @@ -1,4 +1,4 @@ -MplexInit | libp2p

                                                                                                                                                  Interface MplexInit

                                                                                                                                                  interface MplexInit {
                                                                                                                                                      disconnectThreshold?: number;
                                                                                                                                                      maxInboundStreams?: number;
                                                                                                                                                      maxMsgSize?: number;
                                                                                                                                                      maxOutboundStreams?: number;
                                                                                                                                                      maxStreamBufferSize?: number;
                                                                                                                                                      maxUnprocessedMessageQueueSize?: number;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  disconnectThreshold? +MplexInit | libp2p

                                                                                                                                                  Interface MplexInit

                                                                                                                                                  interface MplexInit {
                                                                                                                                                      disconnectThreshold?: number;
                                                                                                                                                      maxInboundStreams?: number;
                                                                                                                                                      maxMsgSize?: number;
                                                                                                                                                      maxOutboundStreams?: number;
                                                                                                                                                      maxStreamBufferSize?: number;
                                                                                                                                                      maxUnprocessedMessageQueueSize?: number;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  disconnectThreshold? maxInboundStreams? maxMsgSize? maxOutboundStreams? @@ -9,31 +9,31 @@ will be closed

                                                                                                                                                  Default

                                                                                                                                                  5
                                                                                                                                                  -

                                                                                                                                                  Optional maxInboundStreams

                                                                                                                                                  maxInboundStreams?: number

                                                                                                                                                  The maximum number of multiplexed streams that can be open at any +

                                                                                                                                                  Optional maxInboundStreams

                                                                                                                                                  maxInboundStreams?: number

                                                                                                                                                  The maximum number of multiplexed streams that can be open at any one time. A request to open more than this will have a stream reset message sent immediately as a response for the newly opened stream id

                                                                                                                                                  Default

                                                                                                                                                  1024
                                                                                                                                                  -

                                                                                                                                                  Optional maxMsgSize

                                                                                                                                                  maxMsgSize?: number

                                                                                                                                                  The maximum size of message that can be sent in one go in bytes. +

                                                                                                                                                  Optional maxMsgSize

                                                                                                                                                  maxMsgSize?: number

                                                                                                                                                  The maximum size of message that can be sent in one go in bytes. Messages larger than this will be split into multiple smaller messages. If we receive a message larger than this an error will be thrown and the connection closed.

                                                                                                                                                  Default

                                                                                                                                                  1048576
                                                                                                                                                  -

                                                                                                                                                  Optional maxOutboundStreams

                                                                                                                                                  maxOutboundStreams?: number

                                                                                                                                                  The maximum number of multiplexed streams that can be open at any +

                                                                                                                                                  Optional maxOutboundStreams

                                                                                                                                                  maxOutboundStreams?: number

                                                                                                                                                  The maximum number of multiplexed streams that can be open at any one time. An attempt to open more than this will throw

                                                                                                                                                  Default

                                                                                                                                                  1024
                                                                                                                                                  -

                                                                                                                                                  Optional maxStreamBufferSize

                                                                                                                                                  maxStreamBufferSize?: number

                                                                                                                                                  Incoming stream messages are buffered until processed by the stream +

                                                                                                                                                  Optional maxStreamBufferSize

                                                                                                                                                  maxStreamBufferSize?: number

                                                                                                                                                  Incoming stream messages are buffered until processed by the stream handler. If the buffer reaches this size in bytes the stream will be reset

                                                                                                                                                  Default

                                                                                                                                                  4194304
                                                                                                                                                  -

                                                                                                                                                  Optional maxUnprocessedMessageQueueSize

                                                                                                                                                  maxUnprocessedMessageQueueSize?: number

                                                                                                                                                  Constrains the size of the unprocessed message queue buffer. +

                                                                                                                                                  Optional maxUnprocessedMessageQueueSize

                                                                                                                                                  maxUnprocessedMessageQueueSize?: number

                                                                                                                                                  Constrains the size of the unprocessed message queue buffer. Before messages are deserialized, the raw bytes are buffered to ensure we have the complete message to deserialized. If the queue gets longer than this value an error will be thrown and the connection closed.

                                                                                                                                                  Default

                                                                                                                                                  4194304
                                                                                                                                                  -

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  disconnectThresholdmaxInboundStreamsmaxMsgSizemaxOutboundStreamsmaxStreamBufferSizemaxUnprocessedMessageQueueSize
                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  disconnectThresholdmaxInboundStreamsmaxMsgSizemaxOutboundStreamsmaxStreamBufferSizemaxUnprocessedMessageQueueSize
                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_libp2p_multistream_select.MultistreamSelectInit.html b/interfaces/_libp2p_multistream_select.MultistreamSelectInit.html index 3f6a91448f..5f57bd41ae 100644 --- a/interfaces/_libp2p_multistream_select.MultistreamSelectInit.html +++ b/interfaces/_libp2p_multistream_select.MultistreamSelectInit.html @@ -2,7 +2,7 @@ the optional signal property.

                                                                                                                                                  Example

                                                                                                                                                  const controller = new AbortController()

                                                                                                                                                  aLongRunningOperation({
                                                                                                                                                    signal: controller.signal
                                                                                                                                                  })

                                                                                                                                                  // later

                                                                                                                                                  controller.abort()
                                                                                                                                                  -
                                                                                                                                                  interface MultistreamSelectInit {
                                                                                                                                                      log: Logger;
                                                                                                                                                      maxDataLength?: number;
                                                                                                                                                      maxLengthLength?: number;
                                                                                                                                                      negotiateFully?: boolean;
                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                      yieldBytes?: boolean;
                                                                                                                                                      lengthDecoder?(data): number;
                                                                                                                                                      lengthEncoder?(value): Uint8Array | Uint8ArrayList;
                                                                                                                                                  }

                                                                                                                                                  Hierarchy (view full)

                                                                                                                                                  Properties

                                                                                                                                                  log +
                                                                                                                                                  interface MultistreamSelectInit {
                                                                                                                                                      log: Logger;
                                                                                                                                                      maxDataLength?: number;
                                                                                                                                                      maxLengthLength?: number;
                                                                                                                                                      negotiateFully?: boolean;
                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                      yieldBytes?: boolean;
                                                                                                                                                      lengthDecoder?(data): number;
                                                                                                                                                      lengthEncoder?(value): Uint8Array | Uint8ArrayList;
                                                                                                                                                  }

                                                                                                                                                  Hierarchy (view full)

                                                                                                                                                  Properties

                                                                                                                                                  log maxDataLength? maxLengthLength? negotiateFully? @@ -15,7 +15,7 @@ initial message, saving a round trip for connection establishment.

                                                                                                                                                  Default

                                                                                                                                                  true
                                                                                                                                                  -

                                                                                                                                                  Optional signal

                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                  Optional yieldBytes

                                                                                                                                                  yieldBytes?: boolean

                                                                                                                                                  After the stream is unwrapped, any bytes that have been read from the +

                                                                                                                                                  Optional signal

                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                  Optional yieldBytes

                                                                                                                                                  yieldBytes?: boolean

                                                                                                                                                  After the stream is unwrapped, any bytes that have been read from the incoming stream will be yielded in-order as Uint8Array(s).

                                                                                                                                                  To yield a single Uint8ArrayList with all unread bytes instead, pass false here.

                                                                                                                                                  diff --git a/interfaces/_libp2p_multistream_select.ProtocolStream.html b/interfaces/_libp2p_multistream_select.ProtocolStream.html index e32f40a832..33450fa31c 100644 --- a/interfaces/_libp2p_multistream_select.ProtocolStream.html +++ b/interfaces/_libp2p_multistream_select.ProtocolStream.html @@ -1,3 +1,3 @@ -ProtocolStream | libp2p

                                                                                                                                                  Interface ProtocolStream<Stream>

                                                                                                                                                  interface ProtocolStream<Stream> {
                                                                                                                                                      protocol: string;
                                                                                                                                                      stream: Stream;
                                                                                                                                                  }

                                                                                                                                                  Type Parameters

                                                                                                                                                  • Stream

                                                                                                                                                  Properties

                                                                                                                                                  protocol +ProtocolStream | libp2p

                                                                                                                                                  Interface ProtocolStream<Stream>

                                                                                                                                                  interface ProtocolStream<Stream> {
                                                                                                                                                      protocol: string;
                                                                                                                                                      stream: Stream;
                                                                                                                                                  }

                                                                                                                                                  Type Parameters

                                                                                                                                                  • Stream

                                                                                                                                                  Properties

                                                                                                                                                  protocol stream -

                                                                                                                                                  Properties

                                                                                                                                                  protocol

                                                                                                                                                  protocol: string

                                                                                                                                                  stream

                                                                                                                                                  stream: Stream

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  protocolstream
                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                  Properties

                                                                                                                                                  protocol

                                                                                                                                                  protocol: string

                                                                                                                                                  stream

                                                                                                                                                  stream: Stream

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  protocolstream
                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_libp2p_multistream_select.SelectStream.html b/interfaces/_libp2p_multistream_select.SelectStream.html index 3ef09407ff..bd8f4a1a52 100644 --- a/interfaces/_libp2p_multistream_select.SelectStream.html +++ b/interfaces/_libp2p_multistream_select.SelectStream.html @@ -1,7 +1,7 @@ -SelectStream | libp2p

                                                                                                                                                  Interface SelectStream

                                                                                                                                                  interface SelectStream {
                                                                                                                                                      readStatus?: string;
                                                                                                                                                      sink: Sink<any, any>;
                                                                                                                                                      source: any;
                                                                                                                                                      close?(options?): Promise<void>;
                                                                                                                                                      closeRead?(options?): Promise<void>;
                                                                                                                                                      closeWrite?(options?): Promise<void>;
                                                                                                                                                  }

                                                                                                                                                  Hierarchy

                                                                                                                                                  • Duplex<any, any, any>
                                                                                                                                                    • SelectStream

                                                                                                                                                  Properties

                                                                                                                                                  readStatus? +SelectStream | libp2p

                                                                                                                                                  Interface SelectStream

                                                                                                                                                  interface SelectStream {
                                                                                                                                                      readStatus?: string;
                                                                                                                                                      sink: Sink<any, any>;
                                                                                                                                                      source: any;
                                                                                                                                                      close?(options?): Promise<void>;
                                                                                                                                                      closeRead?(options?): Promise<void>;
                                                                                                                                                      closeWrite?(options?): Promise<void>;
                                                                                                                                                  }

                                                                                                                                                  Hierarchy

                                                                                                                                                  • Duplex<any, any, any>
                                                                                                                                                    • SelectStream

                                                                                                                                                  Properties

                                                                                                                                                  readStatus? sink source

                                                                                                                                                  Methods

                                                                                                                                                  close? closeRead? closeWrite? -

                                                                                                                                                  Properties

                                                                                                                                                  Optional readStatus

                                                                                                                                                  readStatus?: string

                                                                                                                                                  sink

                                                                                                                                                  sink: Sink<any, any>

                                                                                                                                                  source

                                                                                                                                                  source: any

                                                                                                                                                  Methods

                                                                                                                                                  Optional close

                                                                                                                                                  Optional closeRead

                                                                                                                                                  Optional closeWrite

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  readStatussinksourceclosecloseReadcloseWrite
                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                  Properties

                                                                                                                                                  Optional readStatus

                                                                                                                                                  readStatus?: string

                                                                                                                                                  sink

                                                                                                                                                  sink: Sink<any, any>

                                                                                                                                                  source

                                                                                                                                                  source: any

                                                                                                                                                  Methods

                                                                                                                                                  Optional close

                                                                                                                                                  Optional closeRead

                                                                                                                                                  Optional closeWrite

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  readStatussinksourceclosecloseReadcloseWrite
                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_libp2p_opentelemetry_metrics.OpenTelemetryComponents.html b/interfaces/_libp2p_opentelemetry_metrics.OpenTelemetryComponents.html index d31f04c21d..f1c9688a60 100644 --- a/interfaces/_libp2p_opentelemetry_metrics.OpenTelemetryComponents.html +++ b/interfaces/_libp2p_opentelemetry_metrics.OpenTelemetryComponents.html @@ -1,2 +1,2 @@ -OpenTelemetryComponents | libp2p

                                                                                                                                                  Interface OpenTelemetryComponents

                                                                                                                                                  interface OpenTelemetryComponents {
                                                                                                                                                      nodeInfo: NodeInfo;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  nodeInfo -

                                                                                                                                                  Properties

                                                                                                                                                  nodeInfo

                                                                                                                                                  nodeInfo: NodeInfo

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  nodeInfo
                                                                                                                                                  \ No newline at end of file +OpenTelemetryComponents | libp2p

                                                                                                                                                  Interface OpenTelemetryComponents

                                                                                                                                                  interface OpenTelemetryComponents {
                                                                                                                                                      nodeInfo: NodeInfo;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  nodeInfo +

                                                                                                                                                  Properties

                                                                                                                                                  nodeInfo

                                                                                                                                                  nodeInfo: NodeInfo

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  nodeInfo
                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_libp2p_opentelemetry_metrics.OpenTelemetryMetricsInit.html b/interfaces/_libp2p_opentelemetry_metrics.OpenTelemetryMetricsInit.html index 6f4720a8d6..a202252582 100644 --- a/interfaces/_libp2p_opentelemetry_metrics.OpenTelemetryMetricsInit.html +++ b/interfaces/_libp2p_opentelemetry_metrics.OpenTelemetryMetricsInit.html @@ -1,17 +1,17 @@ -OpenTelemetryMetricsInit | libp2p

                                                                                                                                                  Interface OpenTelemetryMetricsInit

                                                                                                                                                  interface OpenTelemetryMetricsInit {
                                                                                                                                                      appName?: string;
                                                                                                                                                      appVersion?: string;
                                                                                                                                                      meterName?: string;
                                                                                                                                                      statfsLocation?: string;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  appName? +OpenTelemetryMetricsInit | libp2p

                                                                                                                                                  Interface OpenTelemetryMetricsInit

                                                                                                                                                  interface OpenTelemetryMetricsInit {
                                                                                                                                                      appName?: string;
                                                                                                                                                      appVersion?: string;
                                                                                                                                                      meterName?: string;
                                                                                                                                                      statfsLocation?: string;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  appName? appVersion? meterName? statfsLocation?

                                                                                                                                                  Properties

                                                                                                                                                  Optional appName

                                                                                                                                                  appName?: string

                                                                                                                                                  The app name used to create the tracer

                                                                                                                                                  Default

                                                                                                                                                  'js-libp2p'
                                                                                                                                                  -

                                                                                                                                                  Optional appVersion

                                                                                                                                                  appVersion?: string

                                                                                                                                                  The app version used to create the tracer.

                                                                                                                                                  +

                                                                                                                                                  Optional appVersion

                                                                                                                                                  appVersion?: string

                                                                                                                                                  The app version used to create the tracer.

                                                                                                                                                  The version number of the running version of libp2p is used as the default.

                                                                                                                                                  -

                                                                                                                                                  Optional meterName

                                                                                                                                                  meterName?: string

                                                                                                                                                  The meter name used for creating metrics

                                                                                                                                                  +

                                                                                                                                                  Optional meterName

                                                                                                                                                  meterName?: string

                                                                                                                                                  The meter name used for creating metrics

                                                                                                                                                  Default

                                                                                                                                                  'js-libp2p'
                                                                                                                                                  -

                                                                                                                                                  Optional statfsLocation

                                                                                                                                                  statfsLocation?: string

                                                                                                                                                  On Node.js platforms the current filesystem usage is reported as the metric +

                                                                                                                                                  Optional statfsLocation

                                                                                                                                                  statfsLocation?: string

                                                                                                                                                  On Node.js platforms the current filesystem usage is reported as the metric nodejs_fs_usage_bytes using the statfs function from node:fs - the default location to stat is the current working directory, configured this location here

                                                                                                                                                  -

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  appNameappVersionmeterNamestatfsLocation
                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  appNameappVersionmeterNamestatfsLocation
                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_libp2p_peer_collections.TrackedPeerListInit.html b/interfaces/_libp2p_peer_collections.TrackedPeerListInit.html index 5f8f7f31fe..2340f899c6 100644 --- a/interfaces/_libp2p_peer_collections.TrackedPeerListInit.html +++ b/interfaces/_libp2p_peer_collections.TrackedPeerListInit.html @@ -1,3 +1,3 @@ -TrackedPeerListInit | libp2p

                                                                                                                                                  Interface TrackedPeerListInit

                                                                                                                                                  interface TrackedPeerListInit {
                                                                                                                                                      metrics?: Metrics;
                                                                                                                                                      name: string;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  metrics? +TrackedPeerListInit | libp2p

                                                                                                                                                  Interface TrackedPeerListInit

                                                                                                                                                  interface TrackedPeerListInit {
                                                                                                                                                      metrics?: Metrics;
                                                                                                                                                      name: string;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  metrics? name -

                                                                                                                                                  Properties

                                                                                                                                                  Optional metrics

                                                                                                                                                  metrics?: Metrics

                                                                                                                                                  name

                                                                                                                                                  name: string

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  metricsname
                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                  Properties

                                                                                                                                                  Optional metrics

                                                                                                                                                  metrics?: Metrics

                                                                                                                                                  name

                                                                                                                                                  name: string

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  metricsname
                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_libp2p_peer_collections.TrackedPeerMapInit.html b/interfaces/_libp2p_peer_collections.TrackedPeerMapInit.html index 3b8accb7b2..d717c4f66f 100644 --- a/interfaces/_libp2p_peer_collections.TrackedPeerMapInit.html +++ b/interfaces/_libp2p_peer_collections.TrackedPeerMapInit.html @@ -1,3 +1,3 @@ -TrackedPeerMapInit | libp2p

                                                                                                                                                  Interface TrackedPeerMapInit

                                                                                                                                                  interface TrackedPeerMapInit {
                                                                                                                                                      metrics?: Metrics;
                                                                                                                                                      name: string;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  metrics? +TrackedPeerMapInit | libp2p

                                                                                                                                                  Interface TrackedPeerMapInit

                                                                                                                                                  interface TrackedPeerMapInit {
                                                                                                                                                      metrics?: Metrics;
                                                                                                                                                      name: string;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  metrics? name -

                                                                                                                                                  Properties

                                                                                                                                                  Optional metrics

                                                                                                                                                  metrics?: Metrics

                                                                                                                                                  name

                                                                                                                                                  name: string

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  metricsname
                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                  Properties

                                                                                                                                                  Optional metrics

                                                                                                                                                  metrics?: Metrics

                                                                                                                                                  name

                                                                                                                                                  name: string

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  metricsname
                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_libp2p_peer_collections.TrackedPeerSetInit.html b/interfaces/_libp2p_peer_collections.TrackedPeerSetInit.html index 0288688177..27410c9348 100644 --- a/interfaces/_libp2p_peer_collections.TrackedPeerSetInit.html +++ b/interfaces/_libp2p_peer_collections.TrackedPeerSetInit.html @@ -1,3 +1,3 @@ -TrackedPeerSetInit | libp2p

                                                                                                                                                  Interface TrackedPeerSetInit

                                                                                                                                                  interface TrackedPeerSetInit {
                                                                                                                                                      metrics?: Metrics;
                                                                                                                                                      name: string;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  metrics? +TrackedPeerSetInit | libp2p

                                                                                                                                                  Interface TrackedPeerSetInit

                                                                                                                                                  interface TrackedPeerSetInit {
                                                                                                                                                      metrics?: Metrics;
                                                                                                                                                      name: string;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  metrics? name -

                                                                                                                                                  Properties

                                                                                                                                                  Optional metrics

                                                                                                                                                  metrics?: Metrics

                                                                                                                                                  name

                                                                                                                                                  name: string

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  metricsname
                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                  Properties

                                                                                                                                                  Optional metrics

                                                                                                                                                  metrics?: Metrics

                                                                                                                                                  name

                                                                                                                                                  name: string

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  metricsname
                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_libp2p_peer_record.PeerRecordInit.html b/interfaces/_libp2p_peer_record.PeerRecordInit.html index badf9ccf61..888decfe41 100644 --- a/interfaces/_libp2p_peer_record.PeerRecordInit.html +++ b/interfaces/_libp2p_peer_record.PeerRecordInit.html @@ -1,6 +1,6 @@ -PeerRecordInit | libp2p

                                                                                                                                                  Interface PeerRecordInit

                                                                                                                                                  interface PeerRecordInit {
                                                                                                                                                      multiaddrs?: Multiaddr[];
                                                                                                                                                      peerId: PeerId;
                                                                                                                                                      seqNumber?: bigint;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  multiaddrs? +PeerRecordInit | libp2p

                                                                                                                                                  Interface PeerRecordInit

                                                                                                                                                  interface PeerRecordInit {
                                                                                                                                                      multiaddrs?: Multiaddr[];
                                                                                                                                                      peerId: PeerId;
                                                                                                                                                      seqNumber?: bigint;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  multiaddrs? peerId seqNumber?

                                                                                                                                                  Properties

                                                                                                                                                  Optional multiaddrs

                                                                                                                                                  multiaddrs?: Multiaddr[]

                                                                                                                                                  Addresses of the associated peer.

                                                                                                                                                  -

                                                                                                                                                  peerId

                                                                                                                                                  peerId: PeerId

                                                                                                                                                  Optional seqNumber

                                                                                                                                                  seqNumber?: bigint

                                                                                                                                                  Monotonically-increasing sequence counter that's used to order PeerRecords in time.

                                                                                                                                                  -

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  multiaddrspeerIdseqNumber
                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                  peerId

                                                                                                                                                  peerId: PeerId

                                                                                                                                                  Optional seqNumber

                                                                                                                                                  seqNumber?: bigint

                                                                                                                                                  Monotonically-increasing sequence counter that's used to order PeerRecords in time.

                                                                                                                                                  +

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  multiaddrspeerIdseqNumber
                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_libp2p_peer_record.RecordEnvelopeInit.html b/interfaces/_libp2p_peer_record.RecordEnvelopeInit.html index 8b61d44100..c2e54af1da 100644 --- a/interfaces/_libp2p_peer_record.RecordEnvelopeInit.html +++ b/interfaces/_libp2p_peer_record.RecordEnvelopeInit.html @@ -1,5 +1,5 @@ -RecordEnvelopeInit | libp2p

                                                                                                                                                  Interface RecordEnvelopeInit

                                                                                                                                                  interface RecordEnvelopeInit {
                                                                                                                                                      payload: Uint8Array;
                                                                                                                                                      payloadType: Uint8Array;
                                                                                                                                                      publicKey: PublicKey;
                                                                                                                                                      signature: Uint8Array;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  payload +RecordEnvelopeInit | libp2p

                                                                                                                                                  Interface RecordEnvelopeInit

                                                                                                                                                  interface RecordEnvelopeInit {
                                                                                                                                                      payload: Uint8Array;
                                                                                                                                                      payloadType: Uint8Array;
                                                                                                                                                      publicKey: PublicKey;
                                                                                                                                                      signature: Uint8Array;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  payload payloadType publicKey signature -

                                                                                                                                                  Properties

                                                                                                                                                  payload

                                                                                                                                                  payload: Uint8Array

                                                                                                                                                  payloadType

                                                                                                                                                  payloadType: Uint8Array

                                                                                                                                                  publicKey

                                                                                                                                                  publicKey: PublicKey

                                                                                                                                                  signature

                                                                                                                                                  signature: Uint8Array

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  payloadpayloadTypepublicKeysignature
                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                  Properties

                                                                                                                                                  payload

                                                                                                                                                  payload: Uint8Array

                                                                                                                                                  payloadType

                                                                                                                                                  payloadType: Uint8Array

                                                                                                                                                  publicKey

                                                                                                                                                  publicKey: PublicKey

                                                                                                                                                  signature

                                                                                                                                                  signature: Uint8Array

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  On This Page

                                                                                                                                                  payloadpayloadTypepublicKeysignature
                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_libp2p_peer_store.AddressFilter.html b/interfaces/_libp2p_peer_store.AddressFilter.html index 8141fa8570..ddf9df3d7c 100644 --- a/interfaces/_libp2p_peer_store.AddressFilter.html +++ b/interfaces/_libp2p_peer_store.AddressFilter.html @@ -1,2 +1,2 @@ AddressFilter | libp2p

                                                                                                                                                  Interface AddressFilter

                                                                                                                                                  Return true to allow storing the passed multiaddr for the passed peer

                                                                                                                                                  -
                                                                                                                                                  interface AddressFilter ((peerId, multiaddr) => boolean | Promise<boolean>)

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                  interface AddressFilter ((peerId, multiaddr) => boolean | Promise<boolean>)

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  Theme

                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_libp2p_peer_store.PersistentPeerStoreComponents.html b/interfaces/_libp2p_peer_store.PersistentPeerStoreComponents.html index 89965bcc93..499a9885c6 100644 --- a/interfaces/_libp2p_peer_store.PersistentPeerStoreComponents.html +++ b/interfaces/_libp2p_peer_store.PersistentPeerStoreComponents.html @@ -1,5 +1,5 @@ -PersistentPeerStoreComponents | libp2p

                                                                                                                                                  Interface PersistentPeerStoreComponents

                                                                                                                                                  interface PersistentPeerStoreComponents {
                                                                                                                                                      datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                      events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                                                                                                                      logger: ComponentLogger;
                                                                                                                                                      peerId: PeerId;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  datastore +PersistentPeerStoreComponents | libp2p

                                                                                                                                                  Interface PersistentPeerStoreComponents

                                                                                                                                                  interface PersistentPeerStoreComponents {
                                                                                                                                                      datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                      events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                                                                                                                      logger: ComponentLogger;
                                                                                                                                                      peerId: PeerId;
                                                                                                                                                  }

                                                                                                                                                  Properties

                                                                                                                                                  datastore events logger peerId -

                                                                                                                                                  Properties

                                                                                                                                                  datastore

                                                                                                                                                  datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                  Type declaration

                                                                                                                                                    Type declaration

                                                                                                                                                      Type declaration

                                                                                                                                                        Type declaration

                                                                                                                                                          Type declaration

                                                                                                                                                            Type declaration

                                                                                                                                                              Type declaration

                                                                                                                                                                Type declaration

                                                                                                                                                                  Type declaration

                                                                                                                                                                    Type declaration

                                                                                                                                                                      events

                                                                                                                                                                      events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                                                                                                                                                      logger

                                                                                                                                                                      logger: ComponentLogger

                                                                                                                                                                      peerId

                                                                                                                                                                      peerId: PeerId

                                                                                                                                                                      Settings

                                                                                                                                                                      Member Visibility

                                                                                                                                                                      Theme

                                                                                                                                                                      On This Page

                                                                                                                                                                      datastoreeventsloggerpeerId
                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                      Properties

                                                                                                                                                                      datastore

                                                                                                                                                                      datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                      Type declaration

                                                                                                                                                                        Type declaration

                                                                                                                                                                          Type declaration

                                                                                                                                                                            Type declaration

                                                                                                                                                                              Type declaration

                                                                                                                                                                                Type declaration

                                                                                                                                                                                  Type declaration

                                                                                                                                                                                    Type declaration

                                                                                                                                                                                      Type declaration

                                                                                                                                                                                        Type declaration

                                                                                                                                                                                          events

                                                                                                                                                                                          events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                                                                                                                                                                          logger

                                                                                                                                                                                          logger: ComponentLogger

                                                                                                                                                                                          peerId

                                                                                                                                                                                          peerId: PeerId

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          datastoreeventsloggerpeerId
                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_libp2p_peer_store.PersistentPeerStoreInit.html b/interfaces/_libp2p_peer_store.PersistentPeerStoreInit.html index ade51c94cc..bd70efcc59 100644 --- a/interfaces/_libp2p_peer_store.PersistentPeerStoreInit.html +++ b/interfaces/_libp2p_peer_store.PersistentPeerStoreInit.html @@ -1,2 +1,2 @@ -PersistentPeerStoreInit | libp2p

                                                                                                                                                                                          Interface PersistentPeerStoreInit

                                                                                                                                                                                          interface PersistentPeerStoreInit {
                                                                                                                                                                                              addressFilter?: AddressFilter;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          addressFilter? -

                                                                                                                                                                                          Properties

                                                                                                                                                                                          Optional addressFilter

                                                                                                                                                                                          addressFilter?: AddressFilter

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          addressFilter
                                                                                                                                                                                          \ No newline at end of file +PersistentPeerStoreInit | libp2p

                                                                                                                                                                                          Interface PersistentPeerStoreInit

                                                                                                                                                                                          interface PersistentPeerStoreInit {
                                                                                                                                                                                              addressFilter?: AddressFilter;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          addressFilter? +

                                                                                                                                                                                          Properties

                                                                                                                                                                                          Optional addressFilter

                                                                                                                                                                                          addressFilter?: AddressFilter

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          addressFilter
                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_libp2p_perf.Perf.html b/interfaces/_libp2p_perf.Perf.html index 938167963e..ff6b84db73 100644 --- a/interfaces/_libp2p_perf.Perf.html +++ b/interfaces/_libp2p_perf.Perf.html @@ -1,2 +1,2 @@ -Perf | libp2p

                                                                                                                                                                                          Interface Perf

                                                                                                                                                                                          interface Perf {
                                                                                                                                                                                              measurePerformance(multiaddr, sendBytes, recvBytes, options?): AsyncGenerator<PerfOutput, any, unknown>;
                                                                                                                                                                                          }

                                                                                                                                                                                          Methods

                                                                                                                                                                                          measurePerformance -

                                                                                                                                                                                          Methods

                                                                                                                                                                                          measurePerformance

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          measurePerformance
                                                                                                                                                                                          \ No newline at end of file +Perf | libp2p

                                                                                                                                                                                          Interface Perf

                                                                                                                                                                                          interface Perf {
                                                                                                                                                                                              measurePerformance(multiaddr, sendBytes, recvBytes, options?): AsyncGenerator<PerfOutput, any, unknown>;
                                                                                                                                                                                          }

                                                                                                                                                                                          Methods

                                                                                                                                                                                          measurePerformance +

                                                                                                                                                                                          Methods

                                                                                                                                                                                          measurePerformance

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          measurePerformance
                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_libp2p_perf.PerfComponents.html b/interfaces/_libp2p_perf.PerfComponents.html index c03093acae..25a4baea29 100644 --- a/interfaces/_libp2p_perf.PerfComponents.html +++ b/interfaces/_libp2p_perf.PerfComponents.html @@ -1,4 +1,4 @@ -PerfComponents | libp2p

                                                                                                                                                                                          Interface PerfComponents

                                                                                                                                                                                          interface PerfComponents {
                                                                                                                                                                                              connectionManager: ConnectionManager;
                                                                                                                                                                                              logger: ComponentLogger;
                                                                                                                                                                                              registrar: Registrar;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          connectionManager +PerfComponents | libp2p

                                                                                                                                                                                          Interface PerfComponents

                                                                                                                                                                                          interface PerfComponents {
                                                                                                                                                                                              connectionManager: ConnectionManager;
                                                                                                                                                                                              logger: ComponentLogger;
                                                                                                                                                                                              registrar: Registrar;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          connectionManager logger registrar -

                                                                                                                                                                                          Properties

                                                                                                                                                                                          connectionManager

                                                                                                                                                                                          connectionManager: ConnectionManager

                                                                                                                                                                                          logger

                                                                                                                                                                                          logger: ComponentLogger

                                                                                                                                                                                          registrar

                                                                                                                                                                                          registrar: Registrar

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          connectionManagerloggerregistrar
                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                          Properties

                                                                                                                                                                                          connectionManager

                                                                                                                                                                                          connectionManager: ConnectionManager

                                                                                                                                                                                          logger

                                                                                                                                                                                          logger: ComponentLogger

                                                                                                                                                                                          registrar

                                                                                                                                                                                          registrar: Registrar

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          connectionManagerloggerregistrar
                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_libp2p_perf.PerfInit.html b/interfaces/_libp2p_perf.PerfInit.html index 5621e486d0..c9357bd71d 100644 --- a/interfaces/_libp2p_perf.PerfInit.html +++ b/interfaces/_libp2p_perf.PerfInit.html @@ -1,9 +1,9 @@ -PerfInit | libp2p

                                                                                                                                                                                          Interface PerfInit

                                                                                                                                                                                          interface PerfInit {
                                                                                                                                                                                              maxInboundStreams?: number;
                                                                                                                                                                                              maxOutboundStreams?: number;
                                                                                                                                                                                              protocolName?: string;
                                                                                                                                                                                              runOnLimitedConnection?: boolean;
                                                                                                                                                                                              writeBlockSize?: number;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          maxInboundStreams? +PerfInit | libp2p

                                                                                                                                                                                          Interface PerfInit

                                                                                                                                                                                          interface PerfInit {
                                                                                                                                                                                              maxInboundStreams?: number;
                                                                                                                                                                                              maxOutboundStreams?: number;
                                                                                                                                                                                              protocolName?: string;
                                                                                                                                                                                              runOnLimitedConnection?: boolean;
                                                                                                                                                                                              writeBlockSize?: number;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          maxInboundStreams? maxOutboundStreams? protocolName? runOnLimitedConnection? writeBlockSize? -

                                                                                                                                                                                          Properties

                                                                                                                                                                                          Optional maxInboundStreams

                                                                                                                                                                                          maxInboundStreams?: number

                                                                                                                                                                                          Optional maxOutboundStreams

                                                                                                                                                                                          maxOutboundStreams?: number

                                                                                                                                                                                          Optional protocolName

                                                                                                                                                                                          protocolName?: string

                                                                                                                                                                                          Optional runOnLimitedConnection

                                                                                                                                                                                          runOnLimitedConnection?: boolean

                                                                                                                                                                                          Optional writeBlockSize

                                                                                                                                                                                          writeBlockSize?: number

                                                                                                                                                                                          Data sent/received will be sent in chunks of this size

                                                                                                                                                                                          +

                                                                                                                                                                                          Properties

                                                                                                                                                                                          Optional maxInboundStreams

                                                                                                                                                                                          maxInboundStreams?: number

                                                                                                                                                                                          Optional maxOutboundStreams

                                                                                                                                                                                          maxOutboundStreams?: number

                                                                                                                                                                                          Optional protocolName

                                                                                                                                                                                          protocolName?: string

                                                                                                                                                                                          Optional runOnLimitedConnection

                                                                                                                                                                                          runOnLimitedConnection?: boolean

                                                                                                                                                                                          Optional writeBlockSize

                                                                                                                                                                                          writeBlockSize?: number

                                                                                                                                                                                          Data sent/received will be sent in chunks of this size

                                                                                                                                                                                          Default

                                                                                                                                                                                          65536
                                                                                                                                                                                          -

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          maxInboundStreamsmaxOutboundStreamsprotocolNamerunOnLimitedConnectionwriteBlockSize
                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          maxInboundStreamsmaxOutboundStreamsprotocolNamerunOnLimitedConnectionwriteBlockSize
                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_libp2p_perf.PerfOptions.html b/interfaces/_libp2p_perf.PerfOptions.html index 1588951112..9fa96366be 100644 --- a/interfaces/_libp2p_perf.PerfOptions.html +++ b/interfaces/_libp2p_perf.PerfOptions.html @@ -2,7 +2,7 @@ the optional signal property.

                                                                                                                                                                                          Example

                                                                                                                                                                                          const controller = new AbortController()

                                                                                                                                                                                          aLongRunningOperation({
                                                                                                                                                                                            signal: controller.signal
                                                                                                                                                                                          })

                                                                                                                                                                                          // later

                                                                                                                                                                                          controller.abort()
                                                                                                                                                                                          -
                                                                                                                                                                                          interface PerfOptions {
                                                                                                                                                                                              reuseExistingConnection?: boolean;
                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                          }

                                                                                                                                                                                          Hierarchy (view full)

                                                                                                                                                                                          Properties

                                                                                                                                                                                          reuseExistingConnection? +
                                                                                                                                                                                          interface PerfOptions {
                                                                                                                                                                                              reuseExistingConnection?: boolean;
                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                          }

                                                                                                                                                                                          Hierarchy (view full)

                                                                                                                                                                                          Properties

                                                                                                                                                                                          reuseExistingConnection? signal?

                                                                                                                                                                                          Properties

                                                                                                                                                                                          Optional reuseExistingConnection

                                                                                                                                                                                          reuseExistingConnection?: boolean

                                                                                                                                                                                          By default measuring perf should include the time it takes to establish a connection, so a new connection will be opened for every performance run.

                                                                                                                                                                                          @@ -10,4 +10,4 @@ true here.

                                                                                                                                                                                          Default

                                                                                                                                                                                          false
                                                                                                                                                                                          -

                                                                                                                                                                                          Optional signal

                                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          reuseExistingConnectionsignal
                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                          Optional signal

                                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          reuseExistingConnectionsignal
                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_libp2p_perf.PerfOutput.html b/interfaces/_libp2p_perf.PerfOutput.html index d3f96007ab..3546644d36 100644 --- a/interfaces/_libp2p_perf.PerfOutput.html +++ b/interfaces/_libp2p_perf.PerfOutput.html @@ -1,5 +1,5 @@ -PerfOutput | libp2p

                                                                                                                                                                                          Interface PerfOutput

                                                                                                                                                                                          interface PerfOutput {
                                                                                                                                                                                              downloadBytes: number;
                                                                                                                                                                                              timeSeconds: number;
                                                                                                                                                                                              type: "stream" | "intermediary" | "connection" | "final";
                                                                                                                                                                                              uploadBytes: number;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          downloadBytes +PerfOutput | libp2p

                                                                                                                                                                                          Interface PerfOutput

                                                                                                                                                                                          interface PerfOutput {
                                                                                                                                                                                              downloadBytes: number;
                                                                                                                                                                                              timeSeconds: number;
                                                                                                                                                                                              type: "stream" | "intermediary" | "connection" | "final";
                                                                                                                                                                                              uploadBytes: number;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          downloadBytes timeSeconds type uploadBytes -

                                                                                                                                                                                          Properties

                                                                                                                                                                                          downloadBytes

                                                                                                                                                                                          downloadBytes: number

                                                                                                                                                                                          timeSeconds

                                                                                                                                                                                          timeSeconds: number

                                                                                                                                                                                          type

                                                                                                                                                                                          type: "stream" | "intermediary" | "connection" | "final"

                                                                                                                                                                                          uploadBytes

                                                                                                                                                                                          uploadBytes: number

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          downloadBytestimeSecondstypeuploadBytes
                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                          Properties

                                                                                                                                                                                          downloadBytes

                                                                                                                                                                                          downloadBytes: number

                                                                                                                                                                                          timeSeconds

                                                                                                                                                                                          timeSeconds: number

                                                                                                                                                                                          type

                                                                                                                                                                                          type: "stream" | "intermediary" | "connection" | "final"

                                                                                                                                                                                          uploadBytes

                                                                                                                                                                                          uploadBytes: number

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          downloadBytestimeSecondstypeuploadBytes
                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_libp2p_ping.PingService.html b/interfaces/_libp2p_ping.PingService.html index d526d5a3dd..2e7e73769d 100644 --- a/interfaces/_libp2p_ping.PingService.html +++ b/interfaces/_libp2p_ping.PingService.html @@ -1,2 +1,2 @@ -PingService | libp2p

                                                                                                                                                                                          Interface PingService

                                                                                                                                                                                          interface PingService {
                                                                                                                                                                                              ping(peer, options?): Promise<number>;
                                                                                                                                                                                          }

                                                                                                                                                                                          Methods

                                                                                                                                                                                          ping -

                                                                                                                                                                                          Methods

                                                                                                                                                                                          ping

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          ping
                                                                                                                                                                                          \ No newline at end of file +PingService | libp2p

                                                                                                                                                                                          Interface PingService

                                                                                                                                                                                          interface PingService {
                                                                                                                                                                                              ping(peer, options?): Promise<number>;
                                                                                                                                                                                          }

                                                                                                                                                                                          Methods

                                                                                                                                                                                          ping +

                                                                                                                                                                                          Methods

                                                                                                                                                                                          ping

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          ping
                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_libp2p_ping.PingServiceComponents.html b/interfaces/_libp2p_ping.PingServiceComponents.html index dd5b2406d0..7065231936 100644 --- a/interfaces/_libp2p_ping.PingServiceComponents.html +++ b/interfaces/_libp2p_ping.PingServiceComponents.html @@ -1,4 +1,4 @@ -PingServiceComponents | libp2p

                                                                                                                                                                                          Interface PingServiceComponents

                                                                                                                                                                                          interface PingServiceComponents {
                                                                                                                                                                                              connectionManager: ConnectionManager;
                                                                                                                                                                                              logger: ComponentLogger;
                                                                                                                                                                                              registrar: Registrar;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          connectionManager +PingServiceComponents | libp2p

                                                                                                                                                                                          Interface PingServiceComponents

                                                                                                                                                                                          interface PingServiceComponents {
                                                                                                                                                                                              connectionManager: ConnectionManager;
                                                                                                                                                                                              logger: ComponentLogger;
                                                                                                                                                                                              registrar: Registrar;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          connectionManager logger registrar -

                                                                                                                                                                                          Properties

                                                                                                                                                                                          connectionManager

                                                                                                                                                                                          connectionManager: ConnectionManager

                                                                                                                                                                                          logger

                                                                                                                                                                                          logger: ComponentLogger

                                                                                                                                                                                          registrar

                                                                                                                                                                                          registrar: Registrar

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          connectionManagerloggerregistrar
                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                          Properties

                                                                                                                                                                                          connectionManager

                                                                                                                                                                                          connectionManager: ConnectionManager

                                                                                                                                                                                          logger

                                                                                                                                                                                          logger: ComponentLogger

                                                                                                                                                                                          registrar

                                                                                                                                                                                          registrar: Registrar

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          connectionManagerloggerregistrar
                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_libp2p_ping.PingServiceInit.html b/interfaces/_libp2p_ping.PingServiceInit.html index fd5eb84010..8bbde4a8dd 100644 --- a/interfaces/_libp2p_ping.PingServiceInit.html +++ b/interfaces/_libp2p_ping.PingServiceInit.html @@ -1,7 +1,7 @@ -PingServiceInit | libp2p

                                                                                                                                                                                          Interface PingServiceInit

                                                                                                                                                                                          interface PingServiceInit {
                                                                                                                                                                                              maxInboundStreams?: number;
                                                                                                                                                                                              maxOutboundStreams?: number;
                                                                                                                                                                                              protocolPrefix?: string;
                                                                                                                                                                                              runOnLimitedConnection?: boolean;
                                                                                                                                                                                              timeout?: number;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          maxInboundStreams? +PingServiceInit | libp2p

                                                                                                                                                                                          Interface PingServiceInit

                                                                                                                                                                                          interface PingServiceInit {
                                                                                                                                                                                              maxInboundStreams?: number;
                                                                                                                                                                                              maxOutboundStreams?: number;
                                                                                                                                                                                              protocolPrefix?: string;
                                                                                                                                                                                              runOnLimitedConnection?: boolean;
                                                                                                                                                                                              timeout?: number;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          maxInboundStreams? maxOutboundStreams? protocolPrefix? runOnLimitedConnection? timeout? -

                                                                                                                                                                                          Properties

                                                                                                                                                                                          Optional maxInboundStreams

                                                                                                                                                                                          maxInboundStreams?: number

                                                                                                                                                                                          Optional maxOutboundStreams

                                                                                                                                                                                          maxOutboundStreams?: number

                                                                                                                                                                                          Optional protocolPrefix

                                                                                                                                                                                          protocolPrefix?: string

                                                                                                                                                                                          Optional runOnLimitedConnection

                                                                                                                                                                                          runOnLimitedConnection?: boolean

                                                                                                                                                                                          Optional timeout

                                                                                                                                                                                          timeout?: number

                                                                                                                                                                                          How long we should wait for a ping response

                                                                                                                                                                                          -

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          maxInboundStreamsmaxOutboundStreamsprotocolPrefixrunOnLimitedConnectiontimeout
                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                          Properties

                                                                                                                                                                                          Optional maxInboundStreams

                                                                                                                                                                                          maxInboundStreams?: number

                                                                                                                                                                                          Optional maxOutboundStreams

                                                                                                                                                                                          maxOutboundStreams?: number

                                                                                                                                                                                          Optional protocolPrefix

                                                                                                                                                                                          protocolPrefix?: string

                                                                                                                                                                                          Optional runOnLimitedConnection

                                                                                                                                                                                          runOnLimitedConnection?: boolean

                                                                                                                                                                                          Optional timeout

                                                                                                                                                                                          timeout?: number

                                                                                                                                                                                          How long we should wait for a ping response

                                                                                                                                                                                          +

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          maxInboundStreamsmaxOutboundStreamsprotocolPrefixrunOnLimitedConnectiontimeout
                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_libp2p_plaintext.PlaintextComponents.html b/interfaces/_libp2p_plaintext.PlaintextComponents.html index 03eb0a7d87..e108b35169 100644 --- a/interfaces/_libp2p_plaintext.PlaintextComponents.html +++ b/interfaces/_libp2p_plaintext.PlaintextComponents.html @@ -1,3 +1,3 @@ -PlaintextComponents | libp2p

                                                                                                                                                                                          Interface PlaintextComponents

                                                                                                                                                                                          interface PlaintextComponents {
                                                                                                                                                                                              logger: ComponentLogger;
                                                                                                                                                                                              privateKey: PrivateKey;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          logger +PlaintextComponents | libp2p

                                                                                                                                                                                          Interface PlaintextComponents

                                                                                                                                                                                          interface PlaintextComponents {
                                                                                                                                                                                              logger: ComponentLogger;
                                                                                                                                                                                              privateKey: PrivateKey;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          logger privateKey -

                                                                                                                                                                                          Properties

                                                                                                                                                                                          logger

                                                                                                                                                                                          logger: ComponentLogger

                                                                                                                                                                                          privateKey

                                                                                                                                                                                          privateKey: PrivateKey

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          loggerprivateKey
                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                          Properties

                                                                                                                                                                                          logger

                                                                                                                                                                                          logger: ComponentLogger

                                                                                                                                                                                          privateKey

                                                                                                                                                                                          privateKey: PrivateKey

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          loggerprivateKey
                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_libp2p_pnet.ProtectorComponents.html b/interfaces/_libp2p_pnet.ProtectorComponents.html index 135d543d65..4ac19959c3 100644 --- a/interfaces/_libp2p_pnet.ProtectorComponents.html +++ b/interfaces/_libp2p_pnet.ProtectorComponents.html @@ -1,2 +1,2 @@ -ProtectorComponents | libp2p

                                                                                                                                                                                          Interface ProtectorComponents

                                                                                                                                                                                          interface ProtectorComponents {
                                                                                                                                                                                              logger: ComponentLogger;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          logger -

                                                                                                                                                                                          Properties

                                                                                                                                                                                          logger

                                                                                                                                                                                          logger: ComponentLogger

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          logger
                                                                                                                                                                                          \ No newline at end of file +ProtectorComponents | libp2p

                                                                                                                                                                                          Interface ProtectorComponents

                                                                                                                                                                                          interface ProtectorComponents {
                                                                                                                                                                                              logger: ComponentLogger;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          logger +

                                                                                                                                                                                          Properties

                                                                                                                                                                                          logger

                                                                                                                                                                                          logger: ComponentLogger

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          logger
                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_libp2p_pnet.ProtectorInit.html b/interfaces/_libp2p_pnet.ProtectorInit.html index 1781a59041..ea918965ff 100644 --- a/interfaces/_libp2p_pnet.ProtectorInit.html +++ b/interfaces/_libp2p_pnet.ProtectorInit.html @@ -1,8 +1,8 @@ -ProtectorInit | libp2p

                                                                                                                                                                                          Interface ProtectorInit

                                                                                                                                                                                          interface ProtectorInit {
                                                                                                                                                                                              psk: Uint8Array;
                                                                                                                                                                                              timeout?: number;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          psk +ProtectorInit | libp2p

                                                                                                                                                                                          Interface ProtectorInit

                                                                                                                                                                                          interface ProtectorInit {
                                                                                                                                                                                              psk: Uint8Array;
                                                                                                                                                                                              timeout?: number;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          psk timeout?

                                                                                                                                                                                          Properties

                                                                                                                                                                                          psk

                                                                                                                                                                                          psk: Uint8Array

                                                                                                                                                                                          A pre-shared key. This must be the same byte value for all peers in the swarm in order for them to communicate.

                                                                                                                                                                                          -

                                                                                                                                                                                          Optional timeout

                                                                                                                                                                                          timeout?: number

                                                                                                                                                                                          The initial nonce exchange must complete within this many milliseconds

                                                                                                                                                                                          +

                                                                                                                                                                                          Optional timeout

                                                                                                                                                                                          timeout?: number

                                                                                                                                                                                          The initial nonce exchange must complete within this many milliseconds

                                                                                                                                                                                          Default

                                                                                                                                                                                          1000
                                                                                                                                                                                          -

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          psktimeout
                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          psktimeout
                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_libp2p_prometheus_metrics.PrometheusCalculatedHistogramOptions.html b/interfaces/_libp2p_prometheus_metrics.PrometheusCalculatedHistogramOptions.html index 27ddffab13..ea5aee91b2 100644 --- a/interfaces/_libp2p_prometheus_metrics.PrometheusCalculatedHistogramOptions.html +++ b/interfaces/_libp2p_prometheus_metrics.PrometheusCalculatedHistogramOptions.html @@ -1,6 +1,6 @@ PrometheusCalculatedHistogramOptions | libp2p

                                                                                                                                                                                          Interface PrometheusCalculatedHistogramOptions<T>

                                                                                                                                                                                          Create tracked metrics that are expensive to calculate by passing a function that is only invoked when metrics are being scraped

                                                                                                                                                                                          -
                                                                                                                                                                                          interface PrometheusCalculatedHistogramOptions<T> {
                                                                                                                                                                                              buckets?: number[];
                                                                                                                                                                                              calculate: CalculateMetric<T>;
                                                                                                                                                                                              help?: string;
                                                                                                                                                                                              label?: string;
                                                                                                                                                                                              registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">;
                                                                                                                                                                                          }

                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                          • T = number

                                                                                                                                                                                          Hierarchy (view full)

                                                                                                                                                                                          Properties

                                                                                                                                                                                          buckets? +
                                                                                                                                                                                          interface PrometheusCalculatedHistogramOptions<T> {
                                                                                                                                                                                              buckets?: number[];
                                                                                                                                                                                              calculate: CalculateMetric<T>;
                                                                                                                                                                                              help?: string;
                                                                                                                                                                                              label?: string;
                                                                                                                                                                                              registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">;
                                                                                                                                                                                          }

                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                          • T = number

                                                                                                                                                                                          Hierarchy (view full)

                                                                                                                                                                                          Properties

                                                                                                                                                                                          buckets? calculate help? label? @@ -10,4 +10,4 @@ using .observe

                                                                                                                                                                                          Optional help

                                                                                                                                                                                          help?: string

                                                                                                                                                                                          Optional help for the metric

                                                                                                                                                                                          Optional label

                                                                                                                                                                                          label?: string

                                                                                                                                                                                          Optional label for the metric

                                                                                                                                                                                          -

                                                                                                                                                                                          Optional registry

                                                                                                                                                                                          registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          bucketscalculatehelplabelregistry
                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                          Optional registry

                                                                                                                                                                                          registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          bucketscalculatehelplabelregistry
                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_libp2p_prometheus_metrics.PrometheusCalculatedMetricOptions.html b/interfaces/_libp2p_prometheus_metrics.PrometheusCalculatedMetricOptions.html index 0302b3060e..62444da669 100644 --- a/interfaces/_libp2p_prometheus_metrics.PrometheusCalculatedMetricOptions.html +++ b/interfaces/_libp2p_prometheus_metrics.PrometheusCalculatedMetricOptions.html @@ -1,6 +1,6 @@ PrometheusCalculatedMetricOptions | libp2p

                                                                                                                                                                                          Interface PrometheusCalculatedMetricOptions<T>

                                                                                                                                                                                          Create tracked metrics that are expensive to calculate by passing a function that is only invoked when metrics are being scraped

                                                                                                                                                                                          -
                                                                                                                                                                                          interface PrometheusCalculatedMetricOptions<T> {
                                                                                                                                                                                              calculate: CalculateMetric<T>;
                                                                                                                                                                                              help?: string;
                                                                                                                                                                                              label?: string;
                                                                                                                                                                                              registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">;
                                                                                                                                                                                          }

                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                          • T = number

                                                                                                                                                                                          Hierarchy (view full)

                                                                                                                                                                                          Properties

                                                                                                                                                                                          calculate +
                                                                                                                                                                                          interface PrometheusCalculatedMetricOptions<T> {
                                                                                                                                                                                              calculate: CalculateMetric<T>;
                                                                                                                                                                                              help?: string;
                                                                                                                                                                                              label?: string;
                                                                                                                                                                                              registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">;
                                                                                                                                                                                          }

                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                          • T = number

                                                                                                                                                                                          Hierarchy (view full)

                                                                                                                                                                                          Properties

                                                                                                                                                                                          calculate help? label? registry? @@ -8,4 +8,4 @@ using .update, .increment, and .decrement

                                                                                                                                                                                          Optional help

                                                                                                                                                                                          help?: string

                                                                                                                                                                                          Optional help for the metric

                                                                                                                                                                                          Optional label

                                                                                                                                                                                          label?: string

                                                                                                                                                                                          Optional label for the metric

                                                                                                                                                                                          -

                                                                                                                                                                                          Optional registry

                                                                                                                                                                                          registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          calculatehelplabelregistry
                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                          Optional registry

                                                                                                                                                                                          registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          calculatehelplabelregistry
                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_libp2p_prometheus_metrics.PrometheusCalculatedSummaryOptions.html b/interfaces/_libp2p_prometheus_metrics.PrometheusCalculatedSummaryOptions.html index b218ae60dd..f8cd5a8bc0 100644 --- a/interfaces/_libp2p_prometheus_metrics.PrometheusCalculatedSummaryOptions.html +++ b/interfaces/_libp2p_prometheus_metrics.PrometheusCalculatedSummaryOptions.html @@ -1,6 +1,6 @@ PrometheusCalculatedSummaryOptions | libp2p

                                                                                                                                                                                          Interface PrometheusCalculatedSummaryOptions<T>

                                                                                                                                                                                          Create tracked metrics that are expensive to calculate by passing a function that is only invoked when metrics are being scraped

                                                                                                                                                                                          -
                                                                                                                                                                                          interface PrometheusCalculatedSummaryOptions<T> {
                                                                                                                                                                                              ageBuckets?: number;
                                                                                                                                                                                              calculate: CalculateMetric<T>;
                                                                                                                                                                                              compressCount?: number;
                                                                                                                                                                                              help?: string;
                                                                                                                                                                                              label?: string;
                                                                                                                                                                                              maxAgeSeconds?: number;
                                                                                                                                                                                              percentiles?: number[];
                                                                                                                                                                                              pruneAgedBuckets?: boolean;
                                                                                                                                                                                              registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">;
                                                                                                                                                                                          }

                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                          • T = number

                                                                                                                                                                                          Hierarchy (view full)

                                                                                                                                                                                          Properties

                                                                                                                                                                                          ageBuckets? +
                                                                                                                                                                                          interface PrometheusCalculatedSummaryOptions<T> {
                                                                                                                                                                                              ageBuckets?: number;
                                                                                                                                                                                              calculate: CalculateMetric<T>;
                                                                                                                                                                                              compressCount?: number;
                                                                                                                                                                                              help?: string;
                                                                                                                                                                                              label?: string;
                                                                                                                                                                                              maxAgeSeconds?: number;
                                                                                                                                                                                              percentiles?: number[];
                                                                                                                                                                                              pruneAgedBuckets?: boolean;
                                                                                                                                                                                              registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">;
                                                                                                                                                                                          }

                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                          • T = number

                                                                                                                                                                                          Hierarchy (view full)

                                                                                                                                                                                          Properties

                                                                                                                                                                                          ageBuckets? calculate compressCount? help? @@ -18,4 +18,4 @@

                                                                                                                                                                                          Optional maxAgeSeconds

                                                                                                                                                                                          maxAgeSeconds?: number

                                                                                                                                                                                          Configure how old a bucket can be before it is reset for sliding window

                                                                                                                                                                                          Optional percentiles

                                                                                                                                                                                          percentiles?: number[]

                                                                                                                                                                                          Percentiles for the summary

                                                                                                                                                                                          Optional pruneAgedBuckets

                                                                                                                                                                                          pruneAgedBuckets?: boolean

                                                                                                                                                                                          Remove entries without any new values in the last maxAgeSeconds

                                                                                                                                                                                          -

                                                                                                                                                                                          Optional registry

                                                                                                                                                                                          registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          ageBucketscalculatecompressCounthelplabelmaxAgeSecondspercentilespruneAgedBucketsregistry
                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                          Optional registry

                                                                                                                                                                                          registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          ageBucketscalculatecompressCounthelplabelmaxAgeSecondspercentilespruneAgedBucketsregistry
                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_libp2p_prometheus_metrics.PrometheusMetricsComponents.html b/interfaces/_libp2p_prometheus_metrics.PrometheusMetricsComponents.html index 85daaced5e..f7df1db7a7 100644 --- a/interfaces/_libp2p_prometheus_metrics.PrometheusMetricsComponents.html +++ b/interfaces/_libp2p_prometheus_metrics.PrometheusMetricsComponents.html @@ -1,2 +1,2 @@ -PrometheusMetricsComponents | libp2p

                                                                                                                                                                                          Interface PrometheusMetricsComponents

                                                                                                                                                                                          interface PrometheusMetricsComponents {
                                                                                                                                                                                              logger: ComponentLogger;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          logger -

                                                                                                                                                                                          Properties

                                                                                                                                                                                          logger

                                                                                                                                                                                          logger: ComponentLogger

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          logger
                                                                                                                                                                                          \ No newline at end of file +PrometheusMetricsComponents | libp2p

                                                                                                                                                                                          Interface PrometheusMetricsComponents

                                                                                                                                                                                          interface PrometheusMetricsComponents {
                                                                                                                                                                                              logger: ComponentLogger;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          logger +

                                                                                                                                                                                          Properties

                                                                                                                                                                                          logger

                                                                                                                                                                                          logger: ComponentLogger

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          logger
                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_libp2p_prometheus_metrics.PrometheusMetricsInit.html b/interfaces/_libp2p_prometheus_metrics.PrometheusMetricsInit.html index 78439f0ade..6b489bf10b 100644 --- a/interfaces/_libp2p_prometheus_metrics.PrometheusMetricsInit.html +++ b/interfaces/_libp2p_prometheus_metrics.PrometheusMetricsInit.html @@ -1,18 +1,18 @@ -PrometheusMetricsInit | libp2p

                                                                                                                                                                                          Interface PrometheusMetricsInit

                                                                                                                                                                                          interface PrometheusMetricsInit {
                                                                                                                                                                                              collectDefaultMetrics?: boolean;
                                                                                                                                                                                              defaultMetrics?: DefaultMetricsCollectorConfiguration<RegistryContentType>;
                                                                                                                                                                                              preserveExistingMetrics?: boolean;
                                                                                                                                                                                              registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">;
                                                                                                                                                                                              statfsLocation?: string;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          collectDefaultMetrics? +PrometheusMetricsInit | libp2p

                                                                                                                                                                                          Interface PrometheusMetricsInit

                                                                                                                                                                                          interface PrometheusMetricsInit {
                                                                                                                                                                                              collectDefaultMetrics?: boolean;
                                                                                                                                                                                              defaultMetrics?: DefaultMetricsCollectorConfiguration<RegistryContentType>;
                                                                                                                                                                                              preserveExistingMetrics?: boolean;
                                                                                                                                                                                              registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">;
                                                                                                                                                                                              statfsLocation?: string;
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          collectDefaultMetrics? defaultMetrics? preserveExistingMetrics? registry? statfsLocation?

                                                                                                                                                                                          Properties

                                                                                                                                                                                          Optional collectDefaultMetrics

                                                                                                                                                                                          collectDefaultMetrics?: boolean

                                                                                                                                                                                          By default we collect default metrics - CPU, memory etc, to not do this, pass true here

                                                                                                                                                                                          -

                                                                                                                                                                                          Optional defaultMetrics

                                                                                                                                                                                          defaultMetrics?: DefaultMetricsCollectorConfiguration<RegistryContentType>

                                                                                                                                                                                          prom-client options to pass to the collectDefaultMetrics function

                                                                                                                                                                                          -

                                                                                                                                                                                          Optional preserveExistingMetrics

                                                                                                                                                                                          preserveExistingMetrics?: boolean

                                                                                                                                                                                          All metrics in prometheus are global so to prevent clashes in naming +

                                                                                                                                                                                          Optional defaultMetrics

                                                                                                                                                                                          defaultMetrics?: DefaultMetricsCollectorConfiguration<RegistryContentType>

                                                                                                                                                                                          prom-client options to pass to the collectDefaultMetrics function

                                                                                                                                                                                          +

                                                                                                                                                                                          Optional preserveExistingMetrics

                                                                                                                                                                                          preserveExistingMetrics?: boolean

                                                                                                                                                                                          All metrics in prometheus are global so to prevent clashes in naming we reset the global metrics registry on creation - to not do this, pass true here

                                                                                                                                                                                          -

                                                                                                                                                                                          Optional registry

                                                                                                                                                                                          registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">

                                                                                                                                                                                          Use a custom registry to register metrics. +

                                                                                                                                                                                          Optional registry

                                                                                                                                                                                          registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">

                                                                                                                                                                                          Use a custom registry to register metrics. By default, the global registry is used to register metrics.

                                                                                                                                                                                          -

                                                                                                                                                                                          Optional statfsLocation

                                                                                                                                                                                          statfsLocation?: string

                                                                                                                                                                                          The current filesystem usage is reported as the metric +

                                                                                                                                                                                          Optional statfsLocation

                                                                                                                                                                                          statfsLocation?: string

                                                                                                                                                                                          The current filesystem usage is reported as the metric nodejs_fs_usage_bytes using the statfs function from node:fs - the default location to stat is the current working directory, configured this location here

                                                                                                                                                                                          -

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          collectDefaultMetricsdefaultMetricspreserveExistingMetricsregistrystatfsLocation
                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          Theme

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          collectDefaultMetricsdefaultMetricspreserveExistingMetricsregistrystatfsLocation
                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_libp2p_pubsub.index.PubSubComponents.html b/interfaces/_libp2p_pubsub.index.PubSubComponents.html index 4be8edaa0a..0ff96aac38 100644 --- a/interfaces/_libp2p_pubsub.index.PubSubComponents.html +++ b/interfaces/_libp2p_pubsub.index.PubSubComponents.html @@ -1,5 +1,5 @@ -PubSubComponents | libp2p

                                                                                                                                                                                          Interface PubSubComponents

                                                                                                                                                                                          interface PubSubComponents {
                                                                                                                                                                                              logger: ComponentLogger;
                                                                                                                                                                                              peerId: PeerId;
                                                                                                                                                                                              privateKey: PrivateKey;
                                                                                                                                                                                              registrar: Registrar;
                                                                                                                                                                                          }

                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                          • PubSubComponents

                                                                                                                                                                                            Properties

                                                                                                                                                                                            logger +PubSubComponents | libp2p

                                                                                                                                                                                            Interface PubSubComponents

                                                                                                                                                                                            interface PubSubComponents {
                                                                                                                                                                                                logger: ComponentLogger;
                                                                                                                                                                                                peerId: PeerId;
                                                                                                                                                                                                privateKey: PrivateKey;
                                                                                                                                                                                                registrar: Registrar;
                                                                                                                                                                                            }

                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                            • PubSubComponents

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger peerId privateKey registrar -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger

                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                              peerId

                                                                                                                                                                                              peerId: PeerId

                                                                                                                                                                                              privateKey

                                                                                                                                                                                              privateKey: PrivateKey

                                                                                                                                                                                              registrar

                                                                                                                                                                                              registrar: Registrar

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              loggerpeerIdprivateKeyregistrar
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger

                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                              peerId

                                                                                                                                                                                              peerId: PeerId

                                                                                                                                                                                              privateKey

                                                                                                                                                                                              privateKey: PrivateKey

                                                                                                                                                                                              registrar

                                                                                                                                                                                              registrar: Registrar

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              loggerpeerIdprivateKeyregistrar
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_pubsub.peer_streams.PeerStreamsComponents.html b/interfaces/_libp2p_pubsub.peer_streams.PeerStreamsComponents.html index 01747726e5..be9c8decb9 100644 --- a/interfaces/_libp2p_pubsub.peer_streams.PeerStreamsComponents.html +++ b/interfaces/_libp2p_pubsub.peer_streams.PeerStreamsComponents.html @@ -1,2 +1,2 @@ -PeerStreamsComponents | libp2p

                                                                                                                                                                                              Interface PeerStreamsComponents

                                                                                                                                                                                              interface PeerStreamsComponents {
                                                                                                                                                                                                  logger: ComponentLogger;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger

                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              logger
                                                                                                                                                                                              \ No newline at end of file +PeerStreamsComponents | libp2p

                                                                                                                                                                                              Interface PeerStreamsComponents

                                                                                                                                                                                              interface PeerStreamsComponents {
                                                                                                                                                                                                  logger: ComponentLogger;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger

                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              logger
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_pubsub.peer_streams.PeerStreamsInit.html b/interfaces/_libp2p_pubsub.peer_streams.PeerStreamsInit.html index 8a32e40484..6bd938cef0 100644 --- a/interfaces/_libp2p_pubsub.peer_streams.PeerStreamsInit.html +++ b/interfaces/_libp2p_pubsub.peer_streams.PeerStreamsInit.html @@ -1,3 +1,3 @@ -PeerStreamsInit | libp2p

                                                                                                                                                                                              Interface PeerStreamsInit

                                                                                                                                                                                              interface PeerStreamsInit {
                                                                                                                                                                                                  id: PeerId;
                                                                                                                                                                                                  protocol: string;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              id +PeerStreamsInit | libp2p

                                                                                                                                                                                              Interface PeerStreamsInit

                                                                                                                                                                                              interface PeerStreamsInit {
                                                                                                                                                                                                  id: PeerId;
                                                                                                                                                                                                  protocol: string;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              id protocol -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              id

                                                                                                                                                                                              id: PeerId

                                                                                                                                                                                              protocol

                                                                                                                                                                                              protocol: string

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              idprotocol
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              id

                                                                                                                                                                                              id: PeerId

                                                                                                                                                                                              protocol

                                                                                                                                                                                              protocol: string

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              idprotocol
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_simple_metrics.OnMetrics.html b/interfaces/_libp2p_simple_metrics.OnMetrics.html index 1199c33164..827bc452e8 100644 --- a/interfaces/_libp2p_simple_metrics.OnMetrics.html +++ b/interfaces/_libp2p_simple_metrics.OnMetrics.html @@ -1 +1 @@ -OnMetrics | libp2p

                                                                                                                                                                                              Interface OnMetrics

                                                                                                                                                                                              interface OnMetrics ((metrics) => void)
                                                                                                                                                                                              • OnMetrics(metrics): void

                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                Returns void

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              \ No newline at end of file +OnMetrics | libp2p

                                                                                                                                                                                              Interface OnMetrics

                                                                                                                                                                                              interface OnMetrics ((metrics) => void)
                                                                                                                                                                                              • OnMetrics(metrics): void

                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                Returns void

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_simple_metrics.SimpleMetricsInit.html b/interfaces/_libp2p_simple_metrics.SimpleMetricsInit.html index 2e66c01ec0..eff5660f20 100644 --- a/interfaces/_libp2p_simple_metrics.SimpleMetricsInit.html +++ b/interfaces/_libp2p_simple_metrics.SimpleMetricsInit.html @@ -1,5 +1,5 @@ -SimpleMetricsInit | libp2p

                                                                                                                                                                                              Interface SimpleMetricsInit

                                                                                                                                                                                              interface SimpleMetricsInit {
                                                                                                                                                                                                  intervalMs?: number;
                                                                                                                                                                                                  onMetrics: OnMetrics;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              intervalMs? +SimpleMetricsInit | libp2p

                                                                                                                                                                                              Interface SimpleMetricsInit

                                                                                                                                                                                              interface SimpleMetricsInit {
                                                                                                                                                                                                  intervalMs?: number;
                                                                                                                                                                                                  onMetrics: OnMetrics;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              intervalMs? onMetrics

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional intervalMs

                                                                                                                                                                                              intervalMs?: number

                                                                                                                                                                                              How often to invoke the onMetrics callback

                                                                                                                                                                                              -

                                                                                                                                                                                              onMetrics

                                                                                                                                                                                              onMetrics: OnMetrics

                                                                                                                                                                                              A callback periodically invoked with collected metrics

                                                                                                                                                                                              -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              intervalMsonMetrics
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              onMetrics

                                                                                                                                                                                              onMetrics: OnMetrics

                                                                                                                                                                                              A callback periodically invoked with collected metrics

                                                                                                                                                                                              +

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              intervalMsonMetrics
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_tcp.CloseServerOnMaxConnectionsOpts.html b/interfaces/_libp2p_tcp.CloseServerOnMaxConnectionsOpts.html index a57e6048eb..0505c86f6f 100644 --- a/interfaces/_libp2p_tcp.CloseServerOnMaxConnectionsOpts.html +++ b/interfaces/_libp2p_tcp.CloseServerOnMaxConnectionsOpts.html @@ -1,7 +1,7 @@ -CloseServerOnMaxConnectionsOpts | libp2p

                                                                                                                                                                                              Interface CloseServerOnMaxConnectionsOpts

                                                                                                                                                                                              interface CloseServerOnMaxConnectionsOpts {
                                                                                                                                                                                                  closeAbove: number;
                                                                                                                                                                                                  listenBelow: number;
                                                                                                                                                                                                  onListenError?(err): void;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              closeAbove +CloseServerOnMaxConnectionsOpts | libp2p

                                                                                                                                                                                              Interface CloseServerOnMaxConnectionsOpts

                                                                                                                                                                                              interface CloseServerOnMaxConnectionsOpts {
                                                                                                                                                                                                  closeAbove: number;
                                                                                                                                                                                                  listenBelow: number;
                                                                                                                                                                                                  onListenError?(err): void;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              closeAbove listenBelow

                                                                                                                                                                                              Methods

                                                                                                                                                                                              onListenError?

                                                                                                                                                                                              Properties

                                                                                                                                                                                              closeAbove

                                                                                                                                                                                              closeAbove: number

                                                                                                                                                                                              Close server once connection count is greater than or equal to closeAbove

                                                                                                                                                                                              -

                                                                                                                                                                                              listenBelow

                                                                                                                                                                                              listenBelow: number

                                                                                                                                                                                              Server listens once connection count is less than listenBelow

                                                                                                                                                                                              -

                                                                                                                                                                                              Methods

                                                                                                                                                                                              Optional onListenError

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              closeAbovelistenBelowonListenError
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              listenBelow

                                                                                                                                                                                              listenBelow: number

                                                                                                                                                                                              Server listens once connection count is less than listenBelow

                                                                                                                                                                                              +

                                                                                                                                                                                              Methods

                                                                                                                                                                                              Optional onListenError

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              closeAbovelistenBelowonListenError
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_tcp.TCPComponents.html b/interfaces/_libp2p_tcp.TCPComponents.html index 0b62c83015..612732087d 100644 --- a/interfaces/_libp2p_tcp.TCPComponents.html +++ b/interfaces/_libp2p_tcp.TCPComponents.html @@ -1,3 +1,3 @@ -TCPComponents | libp2p

                                                                                                                                                                                              Interface TCPComponents

                                                                                                                                                                                              interface TCPComponents {
                                                                                                                                                                                                  logger: ComponentLogger;
                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger +TCPComponents | libp2p

                                                                                                                                                                                              Interface TCPComponents

                                                                                                                                                                                              interface TCPComponents {
                                                                                                                                                                                                  logger: ComponentLogger;
                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger metrics? -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger

                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                              Optional metrics

                                                                                                                                                                                              metrics?: Metrics

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              loggermetrics
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger

                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                              Optional metrics

                                                                                                                                                                                              metrics?: Metrics

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              loggermetrics
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_tcp.TCPCreateListenerOptions.html b/interfaces/_libp2p_tcp.TCPCreateListenerOptions.html index 31d1ec8c73..c34c26b58e 100644 --- a/interfaces/_libp2p_tcp.TCPCreateListenerOptions.html +++ b/interfaces/_libp2p_tcp.TCPCreateListenerOptions.html @@ -1,14 +1,14 @@ TCPCreateListenerOptions | libp2p

                                                                                                                                                                                              Interface TCPCreateListenerOptions

                                                                                                                                                                                              Expose a subset of net.connect options

                                                                                                                                                                                              -
                                                                                                                                                                                              interface TCPCreateListenerOptions {
                                                                                                                                                                                                  allowHalfOpen?: boolean;
                                                                                                                                                                                                  keepAlive?: boolean;
                                                                                                                                                                                                  keepAliveInitialDelay?: number;
                                                                                                                                                                                                  noDelay?: boolean;
                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                                  upgrader: Upgrader;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                              Properties

                                                                                                                                                                                              allowHalfOpen? +
                                                                                                                                                                                              interface TCPCreateListenerOptions {
                                                                                                                                                                                                  allowHalfOpen?: boolean;
                                                                                                                                                                                                  keepAlive?: boolean;
                                                                                                                                                                                                  keepAliveInitialDelay?: number;
                                                                                                                                                                                                  noDelay?: boolean;
                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                                  upgrader: Upgrader;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                              Properties

                                                                                                                                                                                              allowHalfOpen? keepAlive? keepAliveInitialDelay? noDelay? signal? upgrader

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional allowHalfOpen

                                                                                                                                                                                              allowHalfOpen?: boolean

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#new-netsocketoptions

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional keepAlive

                                                                                                                                                                                              keepAlive?: boolean

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional keepAliveInitialDelay

                                                                                                                                                                                              keepAliveInitialDelay?: number

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional noDelay

                                                                                                                                                                                              noDelay?: boolean

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional signal

                                                                                                                                                                                              signal?: AbortSignal

                                                                                                                                                                                              upgrader

                                                                                                                                                                                              upgrader: Upgrader

                                                                                                                                                                                              The upgrader turns a MultiaddrConnection into a Connection and notifies +

                                                                                                                                                                                              Optional keepAlive

                                                                                                                                                                                              keepAlive?: boolean

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional keepAliveInitialDelay

                                                                                                                                                                                              keepAliveInitialDelay?: number

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional noDelay

                                                                                                                                                                                              noDelay?: boolean

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional signal

                                                                                                                                                                                              signal?: AbortSignal

                                                                                                                                                                                              upgrader

                                                                                                                                                                                              upgrader: Upgrader

                                                                                                                                                                                              The upgrader turns a MultiaddrConnection into a Connection and notifies other libp2p components about a new incoming connection.

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              allowHalfOpenkeepAlivekeepAliveInitialDelaynoDelaysignalupgrader
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_tcp.TCPDialOptions.html b/interfaces/_libp2p_tcp.TCPDialOptions.html index 12f4e19849..dece79b905 100644 --- a/interfaces/_libp2p_tcp.TCPDialOptions.html +++ b/interfaces/_libp2p_tcp.TCPDialOptions.html @@ -1,5 +1,5 @@ TCPDialOptions | libp2p

                                                                                                                                                                                              Interface TCPDialOptions

                                                                                                                                                                                              Expose a subset of net.connect options

                                                                                                                                                                                              -
                                                                                                                                                                                              interface TCPDialOptions {
                                                                                                                                                                                                  allowHalfOpen?: boolean;
                                                                                                                                                                                                  keepAlive?: boolean;
                                                                                                                                                                                                  keepAliveInitialDelay?: number;
                                                                                                                                                                                                  noDelay?: boolean;
                                                                                                                                                                                                  onProgress?: ((evt) => void);
                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                                  upgrader: Upgrader;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                              Properties

                                                                                                                                                                                              allowHalfOpen? +
                                                                                                                                                                                              interface TCPDialOptions {
                                                                                                                                                                                                  allowHalfOpen?: boolean;
                                                                                                                                                                                                  keepAlive?: boolean;
                                                                                                                                                                                                  keepAliveInitialDelay?: number;
                                                                                                                                                                                                  noDelay?: boolean;
                                                                                                                                                                                                  onProgress?: ((evt) => void);
                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                                  upgrader: Upgrader;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                              Properties

                                                                                                                                                                                              allowHalfOpen? keepAlive? keepAliveInitialDelay? noDelay? @@ -7,9 +7,9 @@ signal? upgrader

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional allowHalfOpen

                                                                                                                                                                                              allowHalfOpen?: boolean

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#new-netsocketoptions

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional keepAlive

                                                                                                                                                                                              keepAlive?: boolean

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional keepAliveInitialDelay

                                                                                                                                                                                              keepAliveInitialDelay?: number

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional noDelay

                                                                                                                                                                                              noDelay?: boolean

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional onProgress

                                                                                                                                                                                              onProgress?: ((evt) => void)

                                                                                                                                                                                              Type declaration

                                                                                                                                                                                              Optional signal

                                                                                                                                                                                              signal?: AbortSignal

                                                                                                                                                                                              upgrader

                                                                                                                                                                                              upgrader: Upgrader

                                                                                                                                                                                              The upgrader turns a MultiaddrConnection into a Connection which should be +

                                                                                                                                                                                              Optional keepAlive

                                                                                                                                                                                              keepAlive?: boolean

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional keepAliveInitialDelay

                                                                                                                                                                                              keepAliveInitialDelay?: number

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional noDelay

                                                                                                                                                                                              noDelay?: boolean

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional onProgress

                                                                                                                                                                                              onProgress?: ((evt) => void)

                                                                                                                                                                                              Type declaration

                                                                                                                                                                                              Optional signal

                                                                                                                                                                                              signal?: AbortSignal

                                                                                                                                                                                              upgrader

                                                                                                                                                                                              upgrader: Upgrader

                                                                                                                                                                                              The upgrader turns a MultiaddrConnection into a Connection which should be returned by the transport's dial method

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              allowHalfOpenkeepAlivekeepAliveInitialDelaynoDelayonProgresssignalupgrader
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_tcp.TCPMetrics.html b/interfaces/_libp2p_tcp.TCPMetrics.html index 3c2daf1819..910600aca9 100644 --- a/interfaces/_libp2p_tcp.TCPMetrics.html +++ b/interfaces/_libp2p_tcp.TCPMetrics.html @@ -1,3 +1,3 @@ -TCPMetrics | libp2p

                                                                                                                                                                                              Interface TCPMetrics

                                                                                                                                                                                              interface TCPMetrics {
                                                                                                                                                                                                  errors: CounterGroup<"outbound_to_connection" | "outbound_upgrade">;
                                                                                                                                                                                                  events: CounterGroup<"error" | "connect" | "timeout" | "abort">;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              errors +TCPMetrics | libp2p

                                                                                                                                                                                              Interface TCPMetrics

                                                                                                                                                                                              interface TCPMetrics {
                                                                                                                                                                                                  errors: CounterGroup<"outbound_to_connection" | "outbound_upgrade">;
                                                                                                                                                                                                  events: CounterGroup<"error" | "connect" | "timeout" | "abort">;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              errors events -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              errors

                                                                                                                                                                                              errors: CounterGroup<"outbound_to_connection" | "outbound_upgrade">

                                                                                                                                                                                              events

                                                                                                                                                                                              events: CounterGroup<"error" | "connect" | "timeout" | "abort">

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              errorsevents
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              errors

                                                                                                                                                                                              errors: CounterGroup<"outbound_to_connection" | "outbound_upgrade">

                                                                                                                                                                                              events

                                                                                                                                                                                              events: CounterGroup<"error" | "connect" | "timeout" | "abort">

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              errorsevents
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_tcp.TCPOptions.html b/interfaces/_libp2p_tcp.TCPOptions.html index 8c1ca9aad6..52b873d94e 100644 --- a/interfaces/_libp2p_tcp.TCPOptions.html +++ b/interfaces/_libp2p_tcp.TCPOptions.html @@ -1,4 +1,4 @@ -TCPOptions | libp2p

                                                                                                                                                                                              Interface TCPOptions

                                                                                                                                                                                              interface TCPOptions {
                                                                                                                                                                                                  backlog?: number;
                                                                                                                                                                                                  closeServerOnMaxConnections?: CloseServerOnMaxConnectionsOpts;
                                                                                                                                                                                                  dialOpts?: TCPSocketOptions;
                                                                                                                                                                                                  inboundSocketInactivityTimeout?: number;
                                                                                                                                                                                                  listenOpts?: TCPSocketOptions;
                                                                                                                                                                                                  maxConnections?: number;
                                                                                                                                                                                                  outboundSocketInactivityTimeout?: number;
                                                                                                                                                                                                  socketCloseTimeout?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              backlog? +TCPOptions | libp2p

                                                                                                                                                                                              Interface TCPOptions

                                                                                                                                                                                              interface TCPOptions {
                                                                                                                                                                                                  backlog?: number;
                                                                                                                                                                                                  closeServerOnMaxConnections?: CloseServerOnMaxConnectionsOpts;
                                                                                                                                                                                                  dialOpts?: TCPSocketOptions;
                                                                                                                                                                                                  inboundSocketInactivityTimeout?: number;
                                                                                                                                                                                                  listenOpts?: TCPSocketOptions;
                                                                                                                                                                                                  maxConnections?: number;
                                                                                                                                                                                                  outboundSocketInactivityTimeout?: number;
                                                                                                                                                                                                  socketCloseTimeout?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              backlog? closeServerOnMaxConnections? dialOpts? inboundSocketInactivityTimeout? @@ -8,13 +8,13 @@ socketCloseTimeout?

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional backlog

                                                                                                                                                                                              backlog?: number

                                                                                                                                                                                              Parameter to specify the maximum length of the queue of pending connections https://nodejs.org/dist/latest-v18.x/docs/api/net.html#serverlisten

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional closeServerOnMaxConnections

                                                                                                                                                                                              closeServerOnMaxConnections?: CloseServerOnMaxConnectionsOpts

                                                                                                                                                                                              Close server (stop listening for new connections) if connections exceed a limit. +

                                                                                                                                                                                              Optional closeServerOnMaxConnections

                                                                                                                                                                                              closeServerOnMaxConnections?: CloseServerOnMaxConnectionsOpts

                                                                                                                                                                                              Close server (stop listening for new connections) if connections exceed a limit. Open server (start listening for new connections) if connections fall below a limit.

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional dialOpts

                                                                                                                                                                                              dialOpts?: TCPSocketOptions

                                                                                                                                                                                              Options passed to net.connect for every opened TCP socket

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional inboundSocketInactivityTimeout

                                                                                                                                                                                              inboundSocketInactivityTimeout?: number

                                                                                                                                                                                              An optional number in ms that is used as an inactivity timeout after which the socket will be closed

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional listenOpts

                                                                                                                                                                                              listenOpts?: TCPSocketOptions

                                                                                                                                                                                              Options passed to every net.createServer for every TCP server

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional maxConnections

                                                                                                                                                                                              maxConnections?: number

                                                                                                                                                                                              Set this property to reject connections when the server's connection count gets high. +

                                                                                                                                                                                              Optional dialOpts

                                                                                                                                                                                              dialOpts?: TCPSocketOptions

                                                                                                                                                                                              Options passed to net.connect for every opened TCP socket

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional inboundSocketInactivityTimeout

                                                                                                                                                                                              inboundSocketInactivityTimeout?: number

                                                                                                                                                                                              An optional number in ms that is used as an inactivity timeout after which the socket will be closed

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional listenOpts

                                                                                                                                                                                              listenOpts?: TCPSocketOptions

                                                                                                                                                                                              Options passed to every net.createServer for every TCP server

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional maxConnections

                                                                                                                                                                                              maxConnections?: number

                                                                                                                                                                                              Set this property to reject connections when the server's connection count gets high. https://nodejs.org/api/net.html#servermaxconnections

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional outboundSocketInactivityTimeout

                                                                                                                                                                                              outboundSocketInactivityTimeout?: number

                                                                                                                                                                                              An optional number in ms that is used as an inactivity timeout after which the socket will be closed

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional socketCloseTimeout

                                                                                                                                                                                              socketCloseTimeout?: number

                                                                                                                                                                                              When closing a socket, wait this long for it to close gracefully before it is closed more forcibly

                                                                                                                                                                                              -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              backlogcloseServerOnMaxConnectionsdialOptsinboundSocketInactivityTimeoutlistenOptsmaxConnectionsoutboundSocketInactivityTimeoutsocketCloseTimeout
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Optional outboundSocketInactivityTimeout

                                                                                                                                                                                              outboundSocketInactivityTimeout?: number

                                                                                                                                                                                              An optional number in ms that is used as an inactivity timeout after which the socket will be closed

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional socketCloseTimeout

                                                                                                                                                                                              socketCloseTimeout?: number

                                                                                                                                                                                              When closing a socket, wait this long for it to close gracefully before it is closed more forcibly

                                                                                                                                                                                              +

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              backlogcloseServerOnMaxConnectionsdialOptsinboundSocketInactivityTimeoutlistenOptsmaxConnectionsoutboundSocketInactivityTimeoutsocketCloseTimeout
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_tcp.TCPSocketOptions.html b/interfaces/_libp2p_tcp.TCPSocketOptions.html index 9e3ed2c27e..67abe682c1 100644 --- a/interfaces/_libp2p_tcp.TCPSocketOptions.html +++ b/interfaces/_libp2p_tcp.TCPSocketOptions.html @@ -1,11 +1,11 @@ TCPSocketOptions | libp2p

                                                                                                                                                                                              Interface TCPSocketOptions

                                                                                                                                                                                              Expose a subset of net.connect options

                                                                                                                                                                                              -
                                                                                                                                                                                              interface TCPSocketOptions {
                                                                                                                                                                                                  allowHalfOpen?: boolean;
                                                                                                                                                                                                  keepAlive?: boolean;
                                                                                                                                                                                                  keepAliveInitialDelay?: number;
                                                                                                                                                                                                  noDelay?: boolean;
                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                              Properties

                                                                                                                                                                                              allowHalfOpen? +
                                                                                                                                                                                              interface TCPSocketOptions {
                                                                                                                                                                                                  allowHalfOpen?: boolean;
                                                                                                                                                                                                  keepAlive?: boolean;
                                                                                                                                                                                                  keepAliveInitialDelay?: number;
                                                                                                                                                                                                  noDelay?: boolean;
                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                              Properties

                                                                                                                                                                                              allowHalfOpen? keepAlive? keepAliveInitialDelay? noDelay? signal?

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional allowHalfOpen

                                                                                                                                                                                              allowHalfOpen?: boolean

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#new-netsocketoptions

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional keepAlive

                                                                                                                                                                                              keepAlive?: boolean

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional keepAliveInitialDelay

                                                                                                                                                                                              keepAliveInitialDelay?: number

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional noDelay

                                                                                                                                                                                              noDelay?: boolean

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional signal

                                                                                                                                                                                              signal?: AbortSignal

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              allowHalfOpenkeepAlivekeepAliveInitialDelaynoDelaysignal
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Optional keepAlive

                                                                                                                                                                                              keepAlive?: boolean

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional keepAliveInitialDelay

                                                                                                                                                                                              keepAliveInitialDelay?: number

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional noDelay

                                                                                                                                                                                              noDelay?: boolean

                                                                                                                                                                                              See

                                                                                                                                                                                              https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional signal

                                                                                                                                                                                              signal?: AbortSignal

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              allowHalfOpenkeepAlivekeepAliveInitialDelaynoDelaysignal
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_tls.TLSComponents.html b/interfaces/_libp2p_tls.TLSComponents.html index ffef66b04c..341d9fecdd 100644 --- a/interfaces/_libp2p_tls.TLSComponents.html +++ b/interfaces/_libp2p_tls.TLSComponents.html @@ -1,3 +1,3 @@ -TLSComponents | libp2p

                                                                                                                                                                                              Interface TLSComponents

                                                                                                                                                                                              interface TLSComponents {
                                                                                                                                                                                                  logger: ComponentLogger;
                                                                                                                                                                                                  privateKey: PrivateKey;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger +TLSComponents | libp2p

                                                                                                                                                                                              Interface TLSComponents

                                                                                                                                                                                              interface TLSComponents {
                                                                                                                                                                                                  logger: ComponentLogger;
                                                                                                                                                                                                  privateKey: PrivateKey;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger privateKey -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger

                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                              privateKey

                                                                                                                                                                                              privateKey: PrivateKey

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              loggerprivateKey
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger

                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                              privateKey

                                                                                                                                                                                              privateKey: PrivateKey

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              loggerprivateKey
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_upnp_nat.PMPOptions.html b/interfaces/_libp2p_upnp_nat.PMPOptions.html index f5c12faf4c..728e725b28 100644 --- a/interfaces/_libp2p_upnp_nat.PMPOptions.html +++ b/interfaces/_libp2p_upnp_nat.PMPOptions.html @@ -1,3 +1,3 @@ -PMPOptions | libp2p

                                                                                                                                                                                              Interface PMPOptions

                                                                                                                                                                                              interface PMPOptions {
                                                                                                                                                                                                  enabled?: boolean;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              enabled? +PMPOptions | libp2p

                                                                                                                                                                                              Interface PMPOptions

                                                                                                                                                                                              interface PMPOptions {
                                                                                                                                                                                                  enabled?: boolean;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              enabled?

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional enabled

                                                                                                                                                                                              enabled?: boolean

                                                                                                                                                                                              Whether to enable PMP as well as UPnP

                                                                                                                                                                                              -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              enabled
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              enabled
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_upnp_nat.UPnPNAT.html b/interfaces/_libp2p_upnp_nat.UPnPNAT.html index a312957d77..1d6cb993d9 100644 --- a/interfaces/_libp2p_upnp_nat.UPnPNAT.html +++ b/interfaces/_libp2p_upnp_nat.UPnPNAT.html @@ -1,2 +1,2 @@ -UPnPNAT | libp2p

                                                                                                                                                                                              Interface UPnPNAT

                                                                                                                                                                                              interface UPnPNAT {
                                                                                                                                                                                                  portMappingClient: UPnPNATClient;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              portMappingClient -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              portMappingClient

                                                                                                                                                                                              portMappingClient: UPnPNATClient

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              portMappingClient
                                                                                                                                                                                              \ No newline at end of file +UPnPNAT | libp2p

                                                                                                                                                                                              Interface UPnPNAT

                                                                                                                                                                                              interface UPnPNAT {
                                                                                                                                                                                                  portMappingClient: UPnPNATClient;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              portMappingClient +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              portMappingClient

                                                                                                                                                                                              portMappingClient: UPnPNATClient

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              portMappingClient
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_upnp_nat.UPnPNATComponents.html b/interfaces/_libp2p_upnp_nat.UPnPNATComponents.html index 4110523f4b..9e52c263cf 100644 --- a/interfaces/_libp2p_upnp_nat.UPnPNATComponents.html +++ b/interfaces/_libp2p_upnp_nat.UPnPNATComponents.html @@ -1,6 +1,6 @@ -UPnPNATComponents | libp2p

                                                                                                                                                                                              Interface UPnPNATComponents

                                                                                                                                                                                              interface UPnPNATComponents {
                                                                                                                                                                                                  addressManager: AddressManager;
                                                                                                                                                                                                  events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                                                                                                                                                                  logger: ComponentLogger;
                                                                                                                                                                                                  nodeInfo: NodeInfo;
                                                                                                                                                                                                  peerId: PeerId;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              addressManager +UPnPNATComponents | libp2p

                                                                                                                                                                                              Interface UPnPNATComponents

                                                                                                                                                                                              interface UPnPNATComponents {
                                                                                                                                                                                                  addressManager: AddressManager;
                                                                                                                                                                                                  events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                                                                                                                                                                  logger: ComponentLogger;
                                                                                                                                                                                                  nodeInfo: NodeInfo;
                                                                                                                                                                                                  peerId: PeerId;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              addressManager events logger nodeInfo peerId -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              addressManager

                                                                                                                                                                                              addressManager: AddressManager

                                                                                                                                                                                              events

                                                                                                                                                                                              events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                                                                                                                                                                              logger

                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                              nodeInfo

                                                                                                                                                                                              nodeInfo: NodeInfo

                                                                                                                                                                                              peerId

                                                                                                                                                                                              peerId: PeerId

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              addressManagereventsloggernodeInfopeerId
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              addressManager

                                                                                                                                                                                              addressManager: AddressManager

                                                                                                                                                                                              events

                                                                                                                                                                                              events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                                                                                                                                                                              logger

                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                              nodeInfo

                                                                                                                                                                                              nodeInfo: NodeInfo

                                                                                                                                                                                              peerId

                                                                                                                                                                                              peerId: PeerId

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              addressManagereventsloggernodeInfopeerId
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_upnp_nat.UPnPNATInit.html b/interfaces/_libp2p_upnp_nat.UPnPNATInit.html index bf287b3eac..f09589b1da 100644 --- a/interfaces/_libp2p_upnp_nat.UPnPNATInit.html +++ b/interfaces/_libp2p_upnp_nat.UPnPNATInit.html @@ -1,4 +1,4 @@ -UPnPNATInit | libp2p

                                                                                                                                                                                              Interface UPnPNATInit

                                                                                                                                                                                              interface UPnPNATInit {
                                                                                                                                                                                                  autoConfirmAddress?: boolean;
                                                                                                                                                                                                  externalAddressCheckInterval?: number;
                                                                                                                                                                                                  externalAddressCheckTimeout?: number;
                                                                                                                                                                                                  portMappingAutoRefresh?: boolean;
                                                                                                                                                                                                  portMappingClient?: UPnPNATClient;
                                                                                                                                                                                                  portMappingDescription?: string;
                                                                                                                                                                                                  portMappingRefreshThreshold?: number;
                                                                                                                                                                                                  portMappingTTL?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              autoConfirmAddress? +UPnPNATInit | libp2p

                                                                                                                                                                                              Interface UPnPNATInit

                                                                                                                                                                                              interface UPnPNATInit {
                                                                                                                                                                                                  autoConfirmAddress?: boolean;
                                                                                                                                                                                                  externalAddressCheckInterval?: number;
                                                                                                                                                                                                  externalAddressCheckTimeout?: number;
                                                                                                                                                                                                  portMappingAutoRefresh?: boolean;
                                                                                                                                                                                                  portMappingClient?: UPnPNATClient;
                                                                                                                                                                                                  portMappingDescription?: string;
                                                                                                                                                                                                  portMappingRefreshThreshold?: number;
                                                                                                                                                                                                  portMappingTTL?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              autoConfirmAddress? externalAddressCheckInterval? externalAddressCheckTimeout? portMappingAutoRefresh? @@ -12,25 +12,25 @@

                                                                                                                                                                                              To skip this verification and trust them immediately pass true here

                                                                                                                                                                                              Default

                                                                                                                                                                                              false
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional externalAddressCheckInterval

                                                                                                                                                                                              externalAddressCheckInterval?: number

                                                                                                                                                                                              Check if the external address has changed this often in ms. Ignored if an +

                                                                                                                                                                                              Optional externalAddressCheckInterval

                                                                                                                                                                                              externalAddressCheckInterval?: number

                                                                                                                                                                                              Check if the external address has changed this often in ms. Ignored if an external address is specified.

                                                                                                                                                                                              Default

                                                                                                                                                                                              30000
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional externalAddressCheckTimeout

                                                                                                                                                                                              externalAddressCheckTimeout?: number

                                                                                                                                                                                              Do not take longer than this to check if the external address has changed +

                                                                                                                                                                                              Optional externalAddressCheckTimeout

                                                                                                                                                                                              externalAddressCheckTimeout?: number

                                                                                                                                                                                              Do not take longer than this to check if the external address has changed in ms. Ignored if an external address is specified.

                                                                                                                                                                                              Default

                                                                                                                                                                                              10000
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional portMappingAutoRefresh

                                                                                                                                                                                              portMappingAutoRefresh?: boolean

                                                                                                                                                                                              Whether to automatically refresh UPnP port mappings when their TTL is +

                                                                                                                                                                                              Optional portMappingAutoRefresh

                                                                                                                                                                                              portMappingAutoRefresh?: boolean

                                                                                                                                                                                              Whether to automatically refresh UPnP port mappings when their TTL is reached

                                                                                                                                                                                              Default

                                                                                                                                                                                              true
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional portMappingClient

                                                                                                                                                                                              portMappingClient?: UPnPNATClient

                                                                                                                                                                                              A preconfigured instance of a NatAPI client can be passed as an option, +

                                                                                                                                                                                              Optional portMappingClient

                                                                                                                                                                                              portMappingClient?: UPnPNATClient

                                                                                                                                                                                              A preconfigured instance of a NatAPI client can be passed as an option, otherwise one will be created

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional portMappingDescription

                                                                                                                                                                                              portMappingDescription?: string

                                                                                                                                                                                              A string value to use for the port mapping description on the gateway

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional portMappingRefreshThreshold

                                                                                                                                                                                              portMappingRefreshThreshold?: number

                                                                                                                                                                                              How long before a port mapping expires to refresh it in ms

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional portMappingDescription

                                                                                                                                                                                              portMappingDescription?: string

                                                                                                                                                                                              A string value to use for the port mapping description on the gateway

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional portMappingRefreshThreshold

                                                                                                                                                                                              portMappingRefreshThreshold?: number

                                                                                                                                                                                              How long before a port mapping expires to refresh it in ms

                                                                                                                                                                                              Default

                                                                                                                                                                                              60_000
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional portMappingTTL

                                                                                                                                                                                              portMappingTTL?: number

                                                                                                                                                                                              How long UPnP port mappings should last for in ms

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional portMappingTTL

                                                                                                                                                                                              portMappingTTL?: number

                                                                                                                                                                                              How long UPnP port mappings should last for in ms

                                                                                                                                                                                              Default

                                                                                                                                                                                              720_000
                                                                                                                                                                                              -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              autoConfirmAddressexternalAddressCheckIntervalexternalAddressCheckTimeoutportMappingAutoRefreshportMappingClientportMappingDescriptionportMappingRefreshThresholdportMappingTTL
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              autoConfirmAddressexternalAddressCheckIntervalexternalAddressCheckTimeoutportMappingAutoRefreshportMappingClientportMappingDescriptionportMappingRefreshThresholdportMappingTTL
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.abstract_stream.AbstractStreamInit.html b/interfaces/_libp2p_utils.abstract_stream.AbstractStreamInit.html index 6191bf1b90..9ec4730c2f 100644 --- a/interfaces/_libp2p_utils.abstract_stream.AbstractStreamInit.html +++ b/interfaces/_libp2p_utils.abstract_stream.AbstractStreamInit.html @@ -1,4 +1,4 @@ -AbstractStreamInit | libp2p

                                                                                                                                                                                              Interface AbstractStreamInit

                                                                                                                                                                                              interface AbstractStreamInit {
                                                                                                                                                                                                  closeTimeout?: number;
                                                                                                                                                                                                  direction: Direction;
                                                                                                                                                                                                  id: string;
                                                                                                                                                                                                  log: Logger;
                                                                                                                                                                                                  metadata?: Record<string, unknown>;
                                                                                                                                                                                                  sendCloseWriteTimeout?: number;
                                                                                                                                                                                                  onAbort?(err): void;
                                                                                                                                                                                                  onCloseRead?(): void;
                                                                                                                                                                                                  onCloseWrite?(): void;
                                                                                                                                                                                                  onEnd?(err?): void;
                                                                                                                                                                                                  onReset?(): void;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              closeTimeout? +AbstractStreamInit | libp2p

                                                                                                                                                                                              Interface AbstractStreamInit

                                                                                                                                                                                              interface AbstractStreamInit {
                                                                                                                                                                                                  closeTimeout?: number;
                                                                                                                                                                                                  direction: Direction;
                                                                                                                                                                                                  id: string;
                                                                                                                                                                                                  log: Logger;
                                                                                                                                                                                                  metadata?: Record<string, unknown>;
                                                                                                                                                                                                  sendCloseWriteTimeout?: number;
                                                                                                                                                                                                  onAbort?(err): void;
                                                                                                                                                                                                  onCloseRead?(): void;
                                                                                                                                                                                                  onCloseWrite?(): void;
                                                                                                                                                                                                  onEnd?(err?): void;
                                                                                                                                                                                                  onReset?(): void;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              closeTimeout? direction id log @@ -13,15 +13,15 @@ connection when closing the writable end of the stream.

                                                                                                                                                                                              Default

                                                                                                                                                                                              500
                                                                                                                                                                                              -

                                                                                                                                                                                              direction

                                                                                                                                                                                              direction: Direction

                                                                                                                                                                                              The stream direction

                                                                                                                                                                                              -

                                                                                                                                                                                              id

                                                                                                                                                                                              id: string

                                                                                                                                                                                              A unique identifier for this stream

                                                                                                                                                                                              -

                                                                                                                                                                                              log

                                                                                                                                                                                              log: Logger

                                                                                                                                                                                              A Logger implementation used to log stream-specific information

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional metadata

                                                                                                                                                                                              metadata?: Record<string, unknown>

                                                                                                                                                                                              User specific stream metadata

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional sendCloseWriteTimeout

                                                                                                                                                                                              sendCloseWriteTimeout?: number

                                                                                                                                                                                              After the stream sink has closed, a limit on how long it takes to send +

                                                                                                                                                                                              direction

                                                                                                                                                                                              direction: Direction

                                                                                                                                                                                              The stream direction

                                                                                                                                                                                              +

                                                                                                                                                                                              id

                                                                                                                                                                                              id: string

                                                                                                                                                                                              A unique identifier for this stream

                                                                                                                                                                                              +

                                                                                                                                                                                              log

                                                                                                                                                                                              log: Logger

                                                                                                                                                                                              A Logger implementation used to log stream-specific information

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional metadata

                                                                                                                                                                                              metadata?: Record<string, unknown>

                                                                                                                                                                                              User specific stream metadata

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional sendCloseWriteTimeout

                                                                                                                                                                                              sendCloseWriteTimeout?: number

                                                                                                                                                                                              After the stream sink has closed, a limit on how long it takes to send a close-write message to the remote peer.

                                                                                                                                                                                              -

                                                                                                                                                                                              Methods

                                                                                                                                                                                              Optional onAbort

                                                                                                                                                                                              Optional onCloseRead

                                                                                                                                                                                              Optional onCloseWrite

                                                                                                                                                                                              Optional onEnd

                                                                                                                                                                                              Optional onReset

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              closeTimeoutdirectionidlogmetadatasendCloseWriteTimeoutonAbortonCloseReadonCloseWriteonEndonReset
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Methods

                                                                                                                                                                                              Optional onAbort

                                                                                                                                                                                              Optional onCloseRead

                                                                                                                                                                                              Optional onCloseWrite

                                                                                                                                                                                              Optional onEnd

                                                                                                                                                                                              Optional onReset

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              closeTimeoutdirectionidlogmetadatasendCloseWriteTimeoutonAbortonCloseReadonCloseWriteonEndonReset
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.adaptive_timeout.AdaptiveTimeoutInit.html b/interfaces/_libp2p_utils.adaptive_timeout.AdaptiveTimeoutInit.html index d84b6b0ec6..a1c17a6315 100644 --- a/interfaces/_libp2p_utils.adaptive_timeout.AdaptiveTimeoutInit.html +++ b/interfaces/_libp2p_utils.adaptive_timeout.AdaptiveTimeoutInit.html @@ -1,8 +1,8 @@ -AdaptiveTimeoutInit | libp2p

                                                                                                                                                                                              Interface AdaptiveTimeoutInit

                                                                                                                                                                                              interface AdaptiveTimeoutInit {
                                                                                                                                                                                                  failureMultiplier?: number;
                                                                                                                                                                                                  initialValue?: number;
                                                                                                                                                                                                  interval?: number;
                                                                                                                                                                                                  metricName?: string;
                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                                  minTimeout?: number;
                                                                                                                                                                                                  timeoutMultiplier?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              failureMultiplier? +AdaptiveTimeoutInit | libp2p

                                                                                                                                                                                              Interface AdaptiveTimeoutInit

                                                                                                                                                                                              interface AdaptiveTimeoutInit {
                                                                                                                                                                                                  failureMultiplier?: number;
                                                                                                                                                                                                  initialValue?: number;
                                                                                                                                                                                                  interval?: number;
                                                                                                                                                                                                  metricName?: string;
                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                                  minTimeout?: number;
                                                                                                                                                                                                  timeoutMultiplier?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              failureMultiplier? initialValue? interval? metricName? metrics? minTimeout? timeoutMultiplier? -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional failureMultiplier

                                                                                                                                                                                              failureMultiplier?: number

                                                                                                                                                                                              Optional initialValue

                                                                                                                                                                                              initialValue?: number

                                                                                                                                                                                              Optional interval

                                                                                                                                                                                              interval?: number

                                                                                                                                                                                              Optional metricName

                                                                                                                                                                                              metricName?: string

                                                                                                                                                                                              Optional metrics

                                                                                                                                                                                              metrics?: Metrics

                                                                                                                                                                                              Optional minTimeout

                                                                                                                                                                                              minTimeout?: number

                                                                                                                                                                                              Optional timeoutMultiplier

                                                                                                                                                                                              timeoutMultiplier?: number

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              failureMultiplierinitialValueintervalmetricNamemetricsminTimeouttimeoutMultiplier
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional failureMultiplier

                                                                                                                                                                                              failureMultiplier?: number

                                                                                                                                                                                              Optional initialValue

                                                                                                                                                                                              initialValue?: number

                                                                                                                                                                                              Optional interval

                                                                                                                                                                                              interval?: number

                                                                                                                                                                                              Optional metricName

                                                                                                                                                                                              metricName?: string

                                                                                                                                                                                              Optional metrics

                                                                                                                                                                                              metrics?: Metrics

                                                                                                                                                                                              Optional minTimeout

                                                                                                                                                                                              minTimeout?: number

                                                                                                                                                                                              Optional timeoutMultiplier

                                                                                                                                                                                              timeoutMultiplier?: number

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              failureMultiplierinitialValueintervalmetricNamemetricsminTimeouttimeoutMultiplier
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.adaptive_timeout.AdaptiveTimeoutSignal.html b/interfaces/_libp2p_utils.adaptive_timeout.AdaptiveTimeoutSignal.html index b75db7d883..56cc17a79b 100644 --- a/interfaces/_libp2p_utils.adaptive_timeout.AdaptiveTimeoutSignal.html +++ b/interfaces/_libp2p_utils.adaptive_timeout.AdaptiveTimeoutSignal.html @@ -1,4 +1,4 @@ -AdaptiveTimeoutSignal | libp2p

                                                                                                                                                                                              Interface AdaptiveTimeoutSignal

                                                                                                                                                                                              interface AdaptiveTimeoutSignal {
                                                                                                                                                                                                  aborted: boolean;
                                                                                                                                                                                                  clear: (() => void);
                                                                                                                                                                                                  onabort: null | ((this, ev) => any);
                                                                                                                                                                                                  reason: any;
                                                                                                                                                                                                  start: number;
                                                                                                                                                                                                  timeout: number;
                                                                                                                                                                                                  addEventListener<K>(type, listener, options?): void;
                                                                                                                                                                                                  addEventListener(type, listener, options?): void;
                                                                                                                                                                                                  addEventListener<K>(type, listener, options?): void;
                                                                                                                                                                                                  addEventListener(type, listener, options?): void;
                                                                                                                                                                                                  dispatchEvent(event): boolean;
                                                                                                                                                                                                  dispatchEvent(event): boolean;
                                                                                                                                                                                                  removeEventListener<K>(type, listener, options?): void;
                                                                                                                                                                                                  removeEventListener(type, listener, options?): void;
                                                                                                                                                                                                  removeEventListener<K>(type, listener, options?): void;
                                                                                                                                                                                                  removeEventListener(type, listener, options?): void;
                                                                                                                                                                                                  throwIfAborted(): void;
                                                                                                                                                                                                  throwIfAborted(): void;
                                                                                                                                                                                                  throwIfAborted(): void;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                              Properties

                                                                                                                                                                                              aborted +AdaptiveTimeoutSignal | libp2p

                                                                                                                                                                                              Interface AdaptiveTimeoutSignal

                                                                                                                                                                                              interface AdaptiveTimeoutSignal {
                                                                                                                                                                                                  aborted: boolean;
                                                                                                                                                                                                  clear: (() => void);
                                                                                                                                                                                                  onabort: null | ((this, ev) => any);
                                                                                                                                                                                                  reason: any;
                                                                                                                                                                                                  start: number;
                                                                                                                                                                                                  timeout: number;
                                                                                                                                                                                                  addEventListener<K>(type, listener, options?): void;
                                                                                                                                                                                                  addEventListener(type, listener, options?): void;
                                                                                                                                                                                                  addEventListener<K>(type, listener, options?): void;
                                                                                                                                                                                                  addEventListener(type, listener, options?): void;
                                                                                                                                                                                                  dispatchEvent(event): boolean;
                                                                                                                                                                                                  dispatchEvent(event): boolean;
                                                                                                                                                                                                  removeEventListener<K>(type, listener, options?): void;
                                                                                                                                                                                                  removeEventListener(type, listener, options?): void;
                                                                                                                                                                                                  removeEventListener<K>(type, listener, options?): void;
                                                                                                                                                                                                  removeEventListener(type, listener, options?): void;
                                                                                                                                                                                                  throwIfAborted(): void;
                                                                                                                                                                                                  throwIfAborted(): void;
                                                                                                                                                                                                  throwIfAborted(): void;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                              Properties

                                                                                                                                                                                              aborted clear onabort reason @@ -12,7 +12,7 @@

                                                                                                                                                                                              MDN Reference

                                                                                                                                                                                              clear

                                                                                                                                                                                              clear: (() => void)

                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                • (): void

                                                                                                                                                                                                • Returns void

                                                                                                                                                                                              onabort

                                                                                                                                                                                              onabort: null | ((this, ev) => any)

                                                                                                                                                                                              MDN Reference

                                                                                                                                                                                              Type declaration

                                                                                                                                                                                              Readonly reason

                                                                                                                                                                                              reason: any

                                                                                                                                                                                              MDN Reference

                                                                                                                                                                                              -

                                                                                                                                                                                              start

                                                                                                                                                                                              start: number

                                                                                                                                                                                              timeout

                                                                                                                                                                                              timeout: number

                                                                                                                                                                                              Methods

                                                                                                                                                                                              addEventListener

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

                                                                                                                                                                                              • Type Parameters

                                                                                                                                                                                                • K extends "abort"

                                                                                                                                                                                                Parameters

                                                                                                                                                                                                • type: K
                                                                                                                                                                                                • listener: ((this, ev) => any)
                                                                                                                                                                                                    • (this, ev): any

                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                      Returns any

                                                                                                                                                                                                • Optional options: boolean | AddEventListenerOptions

                                                                                                                                                                                                Returns void

                                                                                                                                                                                              • addEventListener(type, listener, options?): void

                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                • type: string
                                                                                                                                                                                                • listener: EventListenerOrEventListenerObject
                                                                                                                                                                                                • Optional options: boolean | AddEventListenerOptions

                                                                                                                                                                                                Returns void

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

                                                                                                                                                                                              • Type Parameters

                                                                                                                                                                                                • K extends "abort"

                                                                                                                                                                                                Parameters

                                                                                                                                                                                                • type: K
                                                                                                                                                                                                • listener: ((this, ev) => any)
                                                                                                                                                                                                    • (this, ev): any

                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                      Returns any

                                                                                                                                                                                                • Optional options: boolean | AddEventListenerOptions

                                                                                                                                                                                                Returns void

                                                                                                                                                                                              • addEventListener(type, listener, options?): void

                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                • type: string
                                                                                                                                                                                                • listener: EventListenerOrEventListenerObject
                                                                                                                                                                                                • Optional options: boolean | AddEventListenerOptions

                                                                                                                                                                                                Returns void

                                                                                                                                                                                              dispatchEvent

                                                                                                                                                                                              • dispatchEvent(event): boolean

                                                                                                                                                                                              • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                                                                                                                                                                +

                                                                                                                                                                                              start

                                                                                                                                                                                              start: number

                                                                                                                                                                                              timeout

                                                                                                                                                                                              timeout: number

                                                                                                                                                                                              Methods

                                                                                                                                                                                              addEventListener

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

                                                                                                                                                                                              • Type Parameters

                                                                                                                                                                                                • K extends "abort"

                                                                                                                                                                                                Parameters

                                                                                                                                                                                                • type: K
                                                                                                                                                                                                • listener: ((this, ev) => any)
                                                                                                                                                                                                    • (this, ev): any

                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                      Returns any

                                                                                                                                                                                                • Optional options: boolean | AddEventListenerOptions

                                                                                                                                                                                                Returns void

                                                                                                                                                                                              • addEventListener(type, listener, options?): void

                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                • type: string
                                                                                                                                                                                                • listener: EventListenerOrEventListenerObject
                                                                                                                                                                                                • Optional options: boolean | AddEventListenerOptions

                                                                                                                                                                                                Returns void

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

                                                                                                                                                                                              • Type Parameters

                                                                                                                                                                                                • K extends "abort"

                                                                                                                                                                                                Parameters

                                                                                                                                                                                                • type: K
                                                                                                                                                                                                • listener: ((this, ev) => any)
                                                                                                                                                                                                    • (this, ev): any

                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                      Returns any

                                                                                                                                                                                                • Optional options: boolean | AddEventListenerOptions

                                                                                                                                                                                                Returns void

                                                                                                                                                                                              • addEventListener(type, listener, options?): void

                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                • type: string
                                                                                                                                                                                                • listener: EventListenerOrEventListenerObject
                                                                                                                                                                                                • Optional options: boolean | AddEventListenerOptions

                                                                                                                                                                                                Returns void

                                                                                                                                                                                              dispatchEvent

                                                                                                                                                                                              • dispatchEvent(event): boolean

                                                                                                                                                                                              • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                                                                                                                                                                MDN Reference

                                                                                                                                                                                                Parameters

                                                                                                                                                                                                Returns boolean

                                                                                                                                                                                              • dispatchEvent(event): boolean

                                                                                                                                                                                              • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                                                                                                                                                                MDN Reference

                                                                                                                                                                                                diff --git a/interfaces/_libp2p_utils.adaptive_timeout.GetTimeoutSignalOptions.html b/interfaces/_libp2p_utils.adaptive_timeout.GetTimeoutSignalOptions.html index 437fae209b..8ff0c8c916 100644 --- a/interfaces/_libp2p_utils.adaptive_timeout.GetTimeoutSignalOptions.html +++ b/interfaces/_libp2p_utils.adaptive_timeout.GetTimeoutSignalOptions.html @@ -1,3 +1,3 @@ -GetTimeoutSignalOptions | libp2p

                                                                                                                                                                                                Interface GetTimeoutSignalOptions

                                                                                                                                                                                                interface GetTimeoutSignalOptions {
                                                                                                                                                                                                    signal?: AbortSignal;
                                                                                                                                                                                                    timeoutFactor?: number;
                                                                                                                                                                                                }

                                                                                                                                                                                                Properties

                                                                                                                                                                                                signal? +GetTimeoutSignalOptions | libp2p

                                                                                                                                                                                                Interface GetTimeoutSignalOptions

                                                                                                                                                                                                interface GetTimeoutSignalOptions {
                                                                                                                                                                                                    signal?: AbortSignal;
                                                                                                                                                                                                    timeoutFactor?: number;
                                                                                                                                                                                                }

                                                                                                                                                                                                Properties

                                                                                                                                                                                                signal? timeoutFactor? -

                                                                                                                                                                                                Properties

                                                                                                                                                                                                Optional signal

                                                                                                                                                                                                signal?: AbortSignal

                                                                                                                                                                                                Optional timeoutFactor

                                                                                                                                                                                                timeoutFactor?: number

                                                                                                                                                                                                Settings

                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                Theme

                                                                                                                                                                                                On This Page

                                                                                                                                                                                                signaltimeoutFactor
                                                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                                                Properties

                                                                                                                                                                                                Optional signal

                                                                                                                                                                                                signal?: AbortSignal

                                                                                                                                                                                                Optional timeoutFactor

                                                                                                                                                                                                timeoutFactor?: number

                                                                                                                                                                                                Settings

                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                Theme

                                                                                                                                                                                                On This Page

                                                                                                                                                                                                signaltimeoutFactor
                                                                                                                                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_utils.close.SafelyCloseConnectionOptions.html b/interfaces/_libp2p_utils.close.SafelyCloseConnectionOptions.html index e7e6888340..72867c00d6 100644 --- a/interfaces/_libp2p_utils.close.SafelyCloseConnectionOptions.html +++ b/interfaces/_libp2p_utils.close.SafelyCloseConnectionOptions.html @@ -2,10 +2,10 @@ the optional signal property.

                                                                                                                                                                                                Example

                                                                                                                                                                                                const controller = new AbortController()

                                                                                                                                                                                                aLongRunningOperation({
                                                                                                                                                                                                  signal: controller.signal
                                                                                                                                                                                                })

                                                                                                                                                                                                // later

                                                                                                                                                                                                controller.abort()
                                                                                                                                                                                                -
                                                                                                                                                                                              interface SafelyCloseConnectionOptions {
                                                                                                                                                                                                  closableProtocols?: string[];
                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                              Properties

                                                                                                                                                                                              closableProtocols? +
                                                                                                                                                                                              interface SafelyCloseConnectionOptions {
                                                                                                                                                                                                  closableProtocols?: string[];
                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                              Properties

                                                                                                                                                                                              closableProtocols? signal?

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional closableProtocols

                                                                                                                                                                                              closableProtocols?: string[]

                                                                                                                                                                                              Only close the stream if it either has no protocol streams open or only ones in this list.

                                                                                                                                                                                              Default

                                                                                                                                                                                              ['/ipfs/id/1.0.0']
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional signal

                                                                                                                                                                                              signal?: AbortSignal

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              closableProtocolssignal
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Optional signal

                                                                                                                                                                                              signal?: AbortSignal

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              closableProtocolssignal
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.debounce.DebouncedFunction.html b/interfaces/_libp2p_utils.debounce.DebouncedFunction.html index 00bf0a5ea6..ec778125ae 100644 --- a/interfaces/_libp2p_utils.debounce.DebouncedFunction.html +++ b/interfaces/_libp2p_utils.debounce.DebouncedFunction.html @@ -1,5 +1,5 @@ DebouncedFunction | libp2p

                                                                                                                                                                                              Interface DebouncedFunction

                                                                                                                                                                                              Implemented by components that have a lifecycle

                                                                                                                                                                                              -
                                                                                                                                                                                              interface DebouncedFunction {
                                                                                                                                                                                                  afterStart?(): void | Promise<void>;
                                                                                                                                                                                                  afterStop?(): void | Promise<void>;
                                                                                                                                                                                                  beforeStart?(): void | Promise<void>;
                                                                                                                                                                                                  beforeStop?(): void | Promise<void>;
                                                                                                                                                                                                  start(): void | Promise<void>;
                                                                                                                                                                                                  stop(): void | Promise<void>;
                                                                                                                                                                                                  (): void;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                              Methods

                                                                                                                                                                                              afterStart? +
                                                                                                                                                                                              interface DebouncedFunction {
                                                                                                                                                                                                  afterStart?(): void | Promise<void>;
                                                                                                                                                                                                  afterStop?(): void | Promise<void>;
                                                                                                                                                                                                  beforeStart?(): void | Promise<void>;
                                                                                                                                                                                                  beforeStop?(): void | Promise<void>;
                                                                                                                                                                                                  start(): void | Promise<void>;
                                                                                                                                                                                                  stop(): void | Promise<void>;
                                                                                                                                                                                                  (): void;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                              Methods

                                                                                                                                                                                              afterStart? afterStop? beforeStart? beforeStop? diff --git a/interfaces/_libp2p_utils.filters.BloomFilterOptions.html b/interfaces/_libp2p_utils.filters.BloomFilterOptions.html index 877f0d56e4..306ea6af8a 100644 --- a/interfaces/_libp2p_utils.filters.BloomFilterOptions.html +++ b/interfaces/_libp2p_utils.filters.BloomFilterOptions.html @@ -1,4 +1,4 @@ -BloomFilterOptions | libp2p

                                                                                                                                                                                              Interface BloomFilterOptions

                                                                                                                                                                                              interface BloomFilterOptions {
                                                                                                                                                                                                  bits?: number;
                                                                                                                                                                                                  hashes?: number;
                                                                                                                                                                                                  seeds?: number[];
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              bits? +BloomFilterOptions | libp2p

                                                                                                                                                                                              Interface BloomFilterOptions

                                                                                                                                                                                              interface BloomFilterOptions {
                                                                                                                                                                                                  bits?: number;
                                                                                                                                                                                                  hashes?: number;
                                                                                                                                                                                                  seeds?: number[];
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              bits? hashes? seeds? -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional bits

                                                                                                                                                                                              bits?: number

                                                                                                                                                                                              Optional hashes

                                                                                                                                                                                              hashes?: number

                                                                                                                                                                                              Optional seeds

                                                                                                                                                                                              seeds?: number[]

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              bitshashesseeds
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional bits

                                                                                                                                                                                              bits?: number

                                                                                                                                                                                              Optional hashes

                                                                                                                                                                                              hashes?: number

                                                                                                                                                                                              Optional seeds

                                                                                                                                                                                              seeds?: number[]

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              bitshashesseeds
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.filters.CuckooFilterInit.html b/interfaces/_libp2p_utils.filters.CuckooFilterInit.html index c672018d51..f89e842e74 100644 --- a/interfaces/_libp2p_utils.filters.CuckooFilterInit.html +++ b/interfaces/_libp2p_utils.filters.CuckooFilterInit.html @@ -1,11 +1,11 @@ -CuckooFilterInit | libp2p

                                                                                                                                                                                              Interface CuckooFilterInit

                                                                                                                                                                                              interface CuckooFilterInit {
                                                                                                                                                                                                  bucketSize?: number;
                                                                                                                                                                                                  filterSize: number;
                                                                                                                                                                                                  fingerprintSize?: number;
                                                                                                                                                                                                  hash?: Hash;
                                                                                                                                                                                                  seed?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                              Properties

                                                                                                                                                                                              bucketSize? +CuckooFilterInit | libp2p

                                                                                                                                                                                              Interface CuckooFilterInit

                                                                                                                                                                                              interface CuckooFilterInit {
                                                                                                                                                                                                  bucketSize?: number;
                                                                                                                                                                                                  filterSize: number;
                                                                                                                                                                                                  fingerprintSize?: number;
                                                                                                                                                                                                  hash?: Hash;
                                                                                                                                                                                                  seed?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                              Properties

                                                                                                                                                                                              bucketSize? filterSize fingerprintSize? hash? seed?

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional bucketSize

                                                                                                                                                                                              bucketSize?: number

                                                                                                                                                                                              How many items to put in each bucket

                                                                                                                                                                                              -

                                                                                                                                                                                              filterSize

                                                                                                                                                                                              filterSize: number

                                                                                                                                                                                              How many items the filter is expected to contain

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional fingerprintSize

                                                                                                                                                                                              fingerprintSize?: number

                                                                                                                                                                                              How many bytes the fingerprint is expected to be

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional hash

                                                                                                                                                                                              hash?: Hash

                                                                                                                                                                                              A non-cryptographic hash implementation

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional seed

                                                                                                                                                                                              seed?: number

                                                                                                                                                                                              A number used to seed the hash

                                                                                                                                                                                              -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              bucketSizefilterSizefingerprintSizehashseed
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              filterSize

                                                                                                                                                                                              filterSize: number

                                                                                                                                                                                              How many items the filter is expected to contain

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional fingerprintSize

                                                                                                                                                                                              fingerprintSize?: number

                                                                                                                                                                                              How many bytes the fingerprint is expected to be

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional hash

                                                                                                                                                                                              hash?: Hash

                                                                                                                                                                                              A non-cryptographic hash implementation

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional seed

                                                                                                                                                                                              seed?: number

                                                                                                                                                                                              A number used to seed the hash

                                                                                                                                                                                              +

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              bucketSizefilterSizefingerprintSizehashseed
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.filters.Filter.html b/interfaces/_libp2p_utils.filters.Filter.html index 5b9d9da7a1..460f81ed32 100644 --- a/interfaces/_libp2p_utils.filters.Filter.html +++ b/interfaces/_libp2p_utils.filters.Filter.html @@ -1,4 +1,4 @@ -Filter | libp2p

                                                                                                                                                                                              Interface Filter

                                                                                                                                                                                              interface Filter {
                                                                                                                                                                                                  add(item): void;
                                                                                                                                                                                                  has(item): boolean;
                                                                                                                                                                                                  remove?(buf): boolean;
                                                                                                                                                                                              }

                                                                                                                                                                                              Implemented by

                                                                                                                                                                                              Methods

                                                                                                                                                                                              add +Filter | libp2p

                                                                                                                                                                                              Interface Filter

                                                                                                                                                                                              interface Filter {
                                                                                                                                                                                                  add(item): void;
                                                                                                                                                                                                  has(item): boolean;
                                                                                                                                                                                                  remove?(buf): boolean;
                                                                                                                                                                                              }

                                                                                                                                                                                              Implemented by

                                                                                                                                                                                              Methods

                                                                                                                                                                                              add has remove? -

                                                                                                                                                                                              Methods

                                                                                                                                                                                              add

                                                                                                                                                                                              has

                                                                                                                                                                                              Optional remove

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              addhasremove
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Methods

                                                                                                                                                                                              add

                                                                                                                                                                                              has

                                                                                                                                                                                              Optional remove

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              addhasremove
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.filters.Hash.html b/interfaces/_libp2p_utils.filters.Hash.html index 0224c8027e..6aed6cd0e1 100644 --- a/interfaces/_libp2p_utils.filters.Hash.html +++ b/interfaces/_libp2p_utils.filters.Hash.html @@ -1,3 +1,3 @@ -Hash | libp2p

                                                                                                                                                                                              Interface Hash

                                                                                                                                                                                              interface Hash {
                                                                                                                                                                                                  hash(input, seed): number;
                                                                                                                                                                                                  hashV(input, seed): Uint8Array;
                                                                                                                                                                                              }

                                                                                                                                                                                              Methods

                                                                                                                                                                                              hash +Hash | libp2p

                                                                                                                                                                                              Interface Hash

                                                                                                                                                                                              interface Hash {
                                                                                                                                                                                                  hash(input, seed): number;
                                                                                                                                                                                                  hashV(input, seed): Uint8Array;
                                                                                                                                                                                              }

                                                                                                                                                                                              Methods

                                                                                                                                                                                              hash hashV -

                                                                                                                                                                                              Methods

                                                                                                                                                                                              hash

                                                                                                                                                                                              hashV

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              hashhashV
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Methods

                                                                                                                                                                                              hash

                                                                                                                                                                                              hashV

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              hashhashV
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.filters.ScalableCuckooFilterInit.html b/interfaces/_libp2p_utils.filters.ScalableCuckooFilterInit.html index 0b6a5739a1..090a257a4a 100644 --- a/interfaces/_libp2p_utils.filters.ScalableCuckooFilterInit.html +++ b/interfaces/_libp2p_utils.filters.ScalableCuckooFilterInit.html @@ -1,13 +1,13 @@ -ScalableCuckooFilterInit | libp2p

                                                                                                                                                                                              Interface ScalableCuckooFilterInit

                                                                                                                                                                                              interface ScalableCuckooFilterInit {
                                                                                                                                                                                                  bucketSize?: number;
                                                                                                                                                                                                  filterSize: number;
                                                                                                                                                                                                  fingerprintSize?: number;
                                                                                                                                                                                                  hash?: Hash;
                                                                                                                                                                                                  scale?: number;
                                                                                                                                                                                                  seed?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                              Properties

                                                                                                                                                                                              bucketSize? +ScalableCuckooFilterInit | libp2p

                                                                                                                                                                                              Interface ScalableCuckooFilterInit

                                                                                                                                                                                              interface ScalableCuckooFilterInit {
                                                                                                                                                                                                  bucketSize?: number;
                                                                                                                                                                                                  filterSize: number;
                                                                                                                                                                                                  fingerprintSize?: number;
                                                                                                                                                                                                  hash?: Hash;
                                                                                                                                                                                                  scale?: number;
                                                                                                                                                                                                  seed?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                              Properties

                                                                                                                                                                                              bucketSize? filterSize fingerprintSize? hash? scale? seed?

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional bucketSize

                                                                                                                                                                                              bucketSize?: number

                                                                                                                                                                                              How many items to put in each bucket

                                                                                                                                                                                              -

                                                                                                                                                                                              filterSize

                                                                                                                                                                                              filterSize: number

                                                                                                                                                                                              How many items the filter is expected to contain

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional fingerprintSize

                                                                                                                                                                                              fingerprintSize?: number

                                                                                                                                                                                              How many bytes the fingerprint is expected to be

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional hash

                                                                                                                                                                                              hash?: Hash

                                                                                                                                                                                              A non-cryptographic hash implementation

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional scale

                                                                                                                                                                                              scale?: number

                                                                                                                                                                                              A number to multiply maxItems by when adding new sub-filters

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional seed

                                                                                                                                                                                              seed?: number

                                                                                                                                                                                              A number used to seed the hash

                                                                                                                                                                                              -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              bucketSizefilterSizefingerprintSizehashscaleseed
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              filterSize

                                                                                                                                                                                              filterSize: number

                                                                                                                                                                                              How many items the filter is expected to contain

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional fingerprintSize

                                                                                                                                                                                              fingerprintSize?: number

                                                                                                                                                                                              How many bytes the fingerprint is expected to be

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional hash

                                                                                                                                                                                              hash?: Hash

                                                                                                                                                                                              A non-cryptographic hash implementation

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional scale

                                                                                                                                                                                              scale?: number

                                                                                                                                                                                              A number to multiply maxItems by when adding new sub-filters

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional seed

                                                                                                                                                                                              seed?: number

                                                                                                                                                                                              A number used to seed the hash

                                                                                                                                                                                              +

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              bucketSizefilterSizefingerprintSizehashscaleseed
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.peer_queue.PeerQueueJobOptions.html b/interfaces/_libp2p_utils.peer_queue.PeerQueueJobOptions.html index 99fad91702..c3364eb7a4 100644 --- a/interfaces/_libp2p_utils.peer_queue.PeerQueueJobOptions.html +++ b/interfaces/_libp2p_utils.peer_queue.PeerQueueJobOptions.html @@ -2,6 +2,6 @@ the optional signal property.

                                                                                                                                                                                              Example

                                                                                                                                                                                              const controller = new AbortController()

                                                                                                                                                                                              aLongRunningOperation({
                                                                                                                                                                                                signal: controller.signal
                                                                                                                                                                                              })

                                                                                                                                                                                              // later

                                                                                                                                                                                              controller.abort()
                                                                                                                                                                                              -
                                                                                                                                                                                              interface PeerQueueJobOptions {
                                                                                                                                                                                                  peerId: PeerId;
                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                              Properties

                                                                                                                                                                                              peerId +
                                                                                                                                                                                              interface PeerQueueJobOptions {
                                                                                                                                                                                                  peerId: PeerId;
                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                              Properties

                                                                                                                                                                                              peerId signal? -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              peerId

                                                                                                                                                                                              peerId: PeerId

                                                                                                                                                                                              Optional signal

                                                                                                                                                                                              signal?: AbortSignal

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              peerIdsignal
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              peerId

                                                                                                                                                                                              peerId: PeerId

                                                                                                                                                                                              Optional signal

                                                                                                                                                                                              signal?: AbortSignal

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              peerIdsignal
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.priority_queue.PriorityQueueJobOptions.html b/interfaces/_libp2p_utils.priority_queue.PriorityQueueJobOptions.html index 8e91de760b..ddfa817bdc 100644 --- a/interfaces/_libp2p_utils.priority_queue.PriorityQueueJobOptions.html +++ b/interfaces/_libp2p_utils.priority_queue.PriorityQueueJobOptions.html @@ -2,6 +2,6 @@ the optional signal property.

                                                                                                                                                                                              Example

                                                                                                                                                                                              const controller = new AbortController()

                                                                                                                                                                                              aLongRunningOperation({
                                                                                                                                                                                                signal: controller.signal
                                                                                                                                                                                              })

                                                                                                                                                                                              // later

                                                                                                                                                                                              controller.abort()
                                                                                                                                                                                              -
                                                                                                                                                                                              interface PriorityQueueJobOptions {
                                                                                                                                                                                                  priority: number;
                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                              Properties

                                                                                                                                                                                              priority +
                                                                                                                                                                                              interface PriorityQueueJobOptions {
                                                                                                                                                                                                  priority: number;
                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                              Properties

                                                                                                                                                                                              priority signal? -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              priority

                                                                                                                                                                                              priority: number

                                                                                                                                                                                              Optional signal

                                                                                                                                                                                              signal?: AbortSignal

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              prioritysignal
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              priority

                                                                                                                                                                                              priority: number

                                                                                                                                                                                              Optional signal

                                                                                                                                                                                              signal?: AbortSignal

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              prioritysignal
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.queue.Comparator.html b/interfaces/_libp2p_utils.queue.Comparator.html index 2840ac607a..35f0616186 100644 --- a/interfaces/_libp2p_utils.queue.Comparator.html +++ b/interfaces/_libp2p_utils.queue.Comparator.html @@ -1 +1 @@ -Comparator | libp2p

                                                                                                                                                                                              Interface Comparator<T>

                                                                                                                                                                                              interface Comparator<T> ((a, b) => -1 | 0 | 1)

                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                              • T

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              \ No newline at end of file +Comparator | libp2p

                                                                                                                                                                                              Interface Comparator<T>

                                                                                                                                                                                              interface Comparator<T> ((a, b) => -1 | 0 | 1)

                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                              • T

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.queue.JobMatcher.html b/interfaces/_libp2p_utils.queue.JobMatcher.html index 12476028a3..6fad620bc7 100644 --- a/interfaces/_libp2p_utils.queue.JobMatcher.html +++ b/interfaces/_libp2p_utils.queue.JobMatcher.html @@ -1 +1 @@ -JobMatcher | libp2p

                                                                                                                                                                                              Interface JobMatcher<JobOptions>

                                                                                                                                                                                              interface JobMatcher<JobOptions> ((options?) => boolean)

                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              \ No newline at end of file +JobMatcher | libp2p

                                                                                                                                                                                              Interface JobMatcher<JobOptions>

                                                                                                                                                                                              interface JobMatcher<JobOptions> ((options?) => boolean)

                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.queue.JobTimeline.html b/interfaces/_libp2p_utils.queue.JobTimeline.html index dcd001199f..981a1ff521 100644 --- a/interfaces/_libp2p_utils.queue.JobTimeline.html +++ b/interfaces/_libp2p_utils.queue.JobTimeline.html @@ -1,4 +1,4 @@ -JobTimeline | libp2p

                                                                                                                                                                                              Interface JobTimeline

                                                                                                                                                                                              interface JobTimeline {
                                                                                                                                                                                                  created: number;
                                                                                                                                                                                                  finished?: number;
                                                                                                                                                                                                  started?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              created +JobTimeline | libp2p

                                                                                                                                                                                              Interface JobTimeline

                                                                                                                                                                                              interface JobTimeline {
                                                                                                                                                                                                  created: number;
                                                                                                                                                                                                  finished?: number;
                                                                                                                                                                                                  started?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              created finished? started? -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              created

                                                                                                                                                                                              created: number

                                                                                                                                                                                              Optional finished

                                                                                                                                                                                              finished?: number

                                                                                                                                                                                              Optional started

                                                                                                                                                                                              started?: number

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              createdfinishedstarted
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              created

                                                                                                                                                                                              created: number

                                                                                                                                                                                              Optional finished

                                                                                                                                                                                              finished?: number

                                                                                                                                                                                              Optional started

                                                                                                                                                                                              started?: number

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              createdfinishedstarted
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.queue.QueueEvents.html b/interfaces/_libp2p_utils.queue.QueueEvents.html index 6cfd07265e..aa1f5333fc 100644 --- a/interfaces/_libp2p_utils.queue.QueueEvents.html +++ b/interfaces/_libp2p_utils.queue.QueueEvents.html @@ -1,4 +1,4 @@ -QueueEvents | libp2p

                                                                                                                                                                                              Interface QueueEvents<JobReturnType, JobOptions>

                                                                                                                                                                                              interface QueueEvents<JobReturnType, JobOptions> {
                                                                                                                                                                                                  active: CustomEvent<any>;
                                                                                                                                                                                                  add: CustomEvent<any>;
                                                                                                                                                                                                  completed: CustomEvent<JobReturnType>;
                                                                                                                                                                                                  empty: CustomEvent<any>;
                                                                                                                                                                                                  error: CustomEvent<Error>;
                                                                                                                                                                                                  failure: CustomEvent<QueueJobFailure<JobReturnType, JobOptions>>;
                                                                                                                                                                                                  idle: CustomEvent<any>;
                                                                                                                                                                                                  next: CustomEvent<any>;
                                                                                                                                                                                                  success: CustomEvent<QueueJobSuccess<JobReturnType, JobOptions>>;
                                                                                                                                                                                              }

                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                              Properties

                                                                                                                                                                                              active +QueueEvents | libp2p

                                                                                                                                                                                              Interface QueueEvents<JobReturnType, JobOptions>

                                                                                                                                                                                              interface QueueEvents<JobReturnType, JobOptions> {
                                                                                                                                                                                                  active: CustomEvent<any>;
                                                                                                                                                                                                  add: CustomEvent<any>;
                                                                                                                                                                                                  completed: CustomEvent<JobReturnType>;
                                                                                                                                                                                                  empty: CustomEvent<any>;
                                                                                                                                                                                                  error: CustomEvent<Error>;
                                                                                                                                                                                                  failure: CustomEvent<QueueJobFailure<JobReturnType, JobOptions>>;
                                                                                                                                                                                                  idle: CustomEvent<any>;
                                                                                                                                                                                                  next: CustomEvent<any>;
                                                                                                                                                                                                  success: CustomEvent<QueueJobSuccess<JobReturnType, JobOptions>>;
                                                                                                                                                                                              }

                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                              Properties

                                                                                                                                                                                              active add completed empty @@ -8,14 +8,14 @@ next success

                                                                                                                                                                                              Properties

                                                                                                                                                                                              active

                                                                                                                                                                                              active: CustomEvent<any>

                                                                                                                                                                                              A job is about to start running

                                                                                                                                                                                              -

                                                                                                                                                                                              add

                                                                                                                                                                                              add: CustomEvent<any>

                                                                                                                                                                                              A job was added to the queue

                                                                                                                                                                                              -

                                                                                                                                                                                              completed

                                                                                                                                                                                              completed: CustomEvent<JobReturnType>

                                                                                                                                                                                              A job has finished successfully

                                                                                                                                                                                              -

                                                                                                                                                                                              empty

                                                                                                                                                                                              empty: CustomEvent<any>

                                                                                                                                                                                              The queue is empty, jobs may be running

                                                                                                                                                                                              -

                                                                                                                                                                                              error

                                                                                                                                                                                              error: CustomEvent<Error>

                                                                                                                                                                                              A job has failed

                                                                                                                                                                                              -

                                                                                                                                                                                              failure

                                                                                                                                                                                              failure: CustomEvent<QueueJobFailure<JobReturnType, JobOptions>>

                                                                                                                                                                                              Emitted just after `"error", a job has failed - this event gives access to +

                                                                                                                                                                                              add

                                                                                                                                                                                              add: CustomEvent<any>

                                                                                                                                                                                              A job was added to the queue

                                                                                                                                                                                              +

                                                                                                                                                                                              completed

                                                                                                                                                                                              completed: CustomEvent<JobReturnType>

                                                                                                                                                                                              A job has finished successfully

                                                                                                                                                                                              +

                                                                                                                                                                                              empty

                                                                                                                                                                                              empty: CustomEvent<any>

                                                                                                                                                                                              The queue is empty, jobs may be running

                                                                                                                                                                                              +

                                                                                                                                                                                              error

                                                                                                                                                                                              error: CustomEvent<Error>

                                                                                                                                                                                              A job has failed

                                                                                                                                                                                              +

                                                                                                                                                                                              failure

                                                                                                                                                                                              failure: CustomEvent<QueueJobFailure<JobReturnType, JobOptions>>

                                                                                                                                                                                              Emitted just after `"error", a job has failed - this event gives access to the job and the thrown error

                                                                                                                                                                                              -

                                                                                                                                                                                              idle

                                                                                                                                                                                              idle: CustomEvent<any>

                                                                                                                                                                                              All jobs have finished and the queue is empty

                                                                                                                                                                                              -

                                                                                                                                                                                              next

                                                                                                                                                                                              next: CustomEvent<any>

                                                                                                                                                                                              A job has finished or failed

                                                                                                                                                                                              -

                                                                                                                                                                                              success

                                                                                                                                                                                              success: CustomEvent<QueueJobSuccess<JobReturnType, JobOptions>>

                                                                                                                                                                                              Emitted just after `"completed", a job has finished successfully - this +

                                                                                                                                                                                              idle

                                                                                                                                                                                              idle: CustomEvent<any>

                                                                                                                                                                                              All jobs have finished and the queue is empty

                                                                                                                                                                                              +

                                                                                                                                                                                              next

                                                                                                                                                                                              next: CustomEvent<any>

                                                                                                                                                                                              A job has finished or failed

                                                                                                                                                                                              +

                                                                                                                                                                                              success

                                                                                                                                                                                              success: CustomEvent<QueueJobSuccess<JobReturnType, JobOptions>>

                                                                                                                                                                                              Emitted just after `"completed", a job has finished successfully - this event gives access to the job and it's result

                                                                                                                                                                                              -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              activeaddcompletedemptyerrorfailureidlenextsuccess
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              activeaddcompletedemptyerrorfailureidlenextsuccess
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.queue.QueueInit.html b/interfaces/_libp2p_utils.queue.QueueInit.html index 4af8376f78..3561a67034 100644 --- a/interfaces/_libp2p_utils.queue.QueueInit.html +++ b/interfaces/_libp2p_utils.queue.QueueInit.html @@ -1,4 +1,4 @@ -QueueInit | libp2p

                                                                                                                                                                                              Interface QueueInit<JobReturnType, JobOptions>

                                                                                                                                                                                              interface QueueInit<JobReturnType, JobOptions> {
                                                                                                                                                                                                  concurrency?: number;
                                                                                                                                                                                                  maxSize?: number;
                                                                                                                                                                                                  metricName?: string;
                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                                  sort?: Comparator<Job<JobOptions, JobReturnType>>;
                                                                                                                                                                                              }

                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                              Properties

                                                                                                                                                                                              concurrency? +QueueInit | libp2p

                                                                                                                                                                                              Interface QueueInit<JobReturnType, JobOptions>

                                                                                                                                                                                              interface QueueInit<JobReturnType, JobOptions> {
                                                                                                                                                                                                  concurrency?: number;
                                                                                                                                                                                                  maxSize?: number;
                                                                                                                                                                                                  metricName?: string;
                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                                  sort?: Comparator<Job<JobOptions, JobReturnType>>;
                                                                                                                                                                                              }

                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                              Properties

                                                                                                                                                                                              concurrency? maxSize? metricName? metrics? @@ -7,11 +7,11 @@

                                                                                                                                                                                              Minimum: 1.

                                                                                                                                                                                              Default

                                                                                                                                                                                              Infinity
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional maxSize

                                                                                                                                                                                              maxSize?: number

                                                                                                                                                                                              If the queue size grows to larger than this number the promise returned +

                                                                                                                                                                                              Optional maxSize

                                                                                                                                                                                              maxSize?: number

                                                                                                                                                                                              If the queue size grows to larger than this number the promise returned from the add function will reject

                                                                                                                                                                                              Default

                                                                                                                                                                                              Infinity
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional metricName

                                                                                                                                                                                              metricName?: string

                                                                                                                                                                                              The name of the metric for the queue length

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional metrics

                                                                                                                                                                                              metrics?: Metrics

                                                                                                                                                                                              An implementation of the libp2p Metrics interface

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional sort

                                                                                                                                                                                              sort?: Comparator<Job<JobOptions, JobReturnType>>

                                                                                                                                                                                              An optional function that will sort the queue after a job has been added

                                                                                                                                                                                              -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              concurrencymaxSizemetricNamemetricssort
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Optional metricName

                                                                                                                                                                                              metricName?: string

                                                                                                                                                                                              The name of the metric for the queue length

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional metrics

                                                                                                                                                                                              metrics?: Metrics

                                                                                                                                                                                              An implementation of the libp2p Metrics interface

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional sort

                                                                                                                                                                                              sort?: Comparator<Job<JobOptions, JobReturnType>>

                                                                                                                                                                                              An optional function that will sort the queue after a job has been added

                                                                                                                                                                                              +

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              concurrencymaxSizemetricNamemetricssort
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.queue.QueueJobFailure.html b/interfaces/_libp2p_utils.queue.QueueJobFailure.html index 05adfa801d..672a95beb1 100644 --- a/interfaces/_libp2p_utils.queue.QueueJobFailure.html +++ b/interfaces/_libp2p_utils.queue.QueueJobFailure.html @@ -1,3 +1,3 @@ -QueueJobFailure | libp2p

                                                                                                                                                                                              Interface QueueJobFailure<JobReturnType, JobOptions>

                                                                                                                                                                                              interface QueueJobFailure<JobReturnType, JobOptions> {
                                                                                                                                                                                                  error: Error;
                                                                                                                                                                                                  job: Job<JobOptions, JobReturnType>;
                                                                                                                                                                                              }

                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                              Properties

                                                                                                                                                                                              error +QueueJobFailure | libp2p

                                                                                                                                                                                              Interface QueueJobFailure<JobReturnType, JobOptions>

                                                                                                                                                                                              interface QueueJobFailure<JobReturnType, JobOptions> {
                                                                                                                                                                                                  error: Error;
                                                                                                                                                                                                  job: Job<JobOptions, JobReturnType>;
                                                                                                                                                                                              }

                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                              Properties

                                                                                                                                                                                              error job -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              error

                                                                                                                                                                                              error: Error

                                                                                                                                                                                              job

                                                                                                                                                                                              job: Job<JobOptions, JobReturnType>

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              errorjob
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              error

                                                                                                                                                                                              error: Error

                                                                                                                                                                                              job

                                                                                                                                                                                              job: Job<JobOptions, JobReturnType>

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              errorjob
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.queue.QueueJobSuccess.html b/interfaces/_libp2p_utils.queue.QueueJobSuccess.html index be11656cab..93f7f01b22 100644 --- a/interfaces/_libp2p_utils.queue.QueueJobSuccess.html +++ b/interfaces/_libp2p_utils.queue.QueueJobSuccess.html @@ -1,3 +1,3 @@ -QueueJobSuccess | libp2p

                                                                                                                                                                                              Interface QueueJobSuccess<JobReturnType, JobOptions>

                                                                                                                                                                                              interface QueueJobSuccess<JobReturnType, JobOptions> {
                                                                                                                                                                                                  job: Job<JobOptions, JobReturnType>;
                                                                                                                                                                                                  result: JobReturnType;
                                                                                                                                                                                              }

                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                              Properties

                                                                                                                                                                                              job +QueueJobSuccess | libp2p

                                                                                                                                                                                              Interface QueueJobSuccess<JobReturnType, JobOptions>

                                                                                                                                                                                              interface QueueJobSuccess<JobReturnType, JobOptions> {
                                                                                                                                                                                                  job: Job<JobOptions, JobReturnType>;
                                                                                                                                                                                                  result: JobReturnType;
                                                                                                                                                                                              }

                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                              Properties

                                                                                                                                                                                              job result -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              job

                                                                                                                                                                                              job: Job<JobOptions, JobReturnType>

                                                                                                                                                                                              result

                                                                                                                                                                                              result: JobReturnType

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              jobresult
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              job

                                                                                                                                                                                              job: Job<JobOptions, JobReturnType>

                                                                                                                                                                                              result

                                                                                                                                                                                              result: JobReturnType

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              jobresult
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.queue.RunFunction.html b/interfaces/_libp2p_utils.queue.RunFunction.html index 669d4ed412..98b67e157e 100644 --- a/interfaces/_libp2p_utils.queue.RunFunction.html +++ b/interfaces/_libp2p_utils.queue.RunFunction.html @@ -1 +1 @@ -RunFunction | libp2p

                                                                                                                                                                                              Interface RunFunction<Options, ReturnType>

                                                                                                                                                                                              interface RunFunction<Options, ReturnType> ((options) => Promise<ReturnType>)

                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              \ No newline at end of file +RunFunction | libp2p

                                                                                                                                                                                              Interface RunFunction<Options, ReturnType>

                                                                                                                                                                                              interface RunFunction<Options, ReturnType> ((options) => Promise<ReturnType>)

                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.rate_limiter.GetKeySecDurationOptions.html b/interfaces/_libp2p_utils.rate_limiter.GetKeySecDurationOptions.html index d6a95b023a..f8a27fc29a 100644 --- a/interfaces/_libp2p_utils.rate_limiter.GetKeySecDurationOptions.html +++ b/interfaces/_libp2p_utils.rate_limiter.GetKeySecDurationOptions.html @@ -1,2 +1,2 @@ -GetKeySecDurationOptions | libp2p

                                                                                                                                                                                              Interface GetKeySecDurationOptions

                                                                                                                                                                                              interface GetKeySecDurationOptions {
                                                                                                                                                                                                  customDuration?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              customDuration? -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional customDuration

                                                                                                                                                                                              customDuration?: number

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              customDuration
                                                                                                                                                                                              \ No newline at end of file +GetKeySecDurationOptions | libp2p

                                                                                                                                                                                              Interface GetKeySecDurationOptions

                                                                                                                                                                                              interface GetKeySecDurationOptions {
                                                                                                                                                                                                  customDuration?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              customDuration? +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional customDuration

                                                                                                                                                                                              customDuration?: number

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              customDuration
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.rate_limiter.RateLimiterInit.html b/interfaces/_libp2p_utils.rate_limiter.RateLimiterInit.html index 3ae5c9a518..c21adf3b86 100644 --- a/interfaces/_libp2p_utils.rate_limiter.RateLimiterInit.html +++ b/interfaces/_libp2p_utils.rate_limiter.RateLimiterInit.html @@ -1,4 +1,4 @@ -RateLimiterInit | libp2p

                                                                                                                                                                                              Interface RateLimiterInit

                                                                                                                                                                                              interface RateLimiterInit {
                                                                                                                                                                                                  blockDuration?: number;
                                                                                                                                                                                                  duration?: number;
                                                                                                                                                                                                  execEvenly?: boolean;
                                                                                                                                                                                                  execEvenlyMinDelayMs?: number;
                                                                                                                                                                                                  keyPrefix?: string;
                                                                                                                                                                                                  points?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              blockDuration? +RateLimiterInit | libp2p

                                                                                                                                                                                              Interface RateLimiterInit

                                                                                                                                                                                              interface RateLimiterInit {
                                                                                                                                                                                                  blockDuration?: number;
                                                                                                                                                                                                  duration?: number;
                                                                                                                                                                                                  execEvenly?: boolean;
                                                                                                                                                                                                  execEvenlyMinDelayMs?: number;
                                                                                                                                                                                                  keyPrefix?: string;
                                                                                                                                                                                                  points?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              blockDuration? duration? execEvenly? execEvenlyMinDelayMs? @@ -7,18 +7,18 @@

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional blockDuration

                                                                                                                                                                                              blockDuration?: number

                                                                                                                                                                                              Block if consumed more than points in current duration for blockDuration seconds

                                                                                                                                                                                              Default

                                                                                                                                                                                              0
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional duration

                                                                                                                                                                                              duration?: number

                                                                                                                                                                                              Per seconds

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional duration

                                                                                                                                                                                              duration?: number

                                                                                                                                                                                              Per seconds

                                                                                                                                                                                              Default

                                                                                                                                                                                              1
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional execEvenly

                                                                                                                                                                                              execEvenly?: boolean

                                                                                                                                                                                              Execute allowed actions evenly over duration

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional execEvenly

                                                                                                                                                                                              execEvenly?: boolean

                                                                                                                                                                                              Execute allowed actions evenly over duration

                                                                                                                                                                                              Default

                                                                                                                                                                                              false
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional execEvenlyMinDelayMs

                                                                                                                                                                                              execEvenlyMinDelayMs?: number

                                                                                                                                                                                              ms, works with execEvenly=true option

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional execEvenlyMinDelayMs

                                                                                                                                                                                              execEvenlyMinDelayMs?: number

                                                                                                                                                                                              ms, works with execEvenly=true option

                                                                                                                                                                                              Default

                                                                                                                                                                                              duration * 1000 / points
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional keyPrefix

                                                                                                                                                                                              keyPrefix?: string

                                                                                                                                                                                              Default

                                                                                                                                                                                              rlflx
+

                                                                                                                                                                                              Optional keyPrefix

                                                                                                                                                                                              keyPrefix?: string

                                                                                                                                                                                              Default

                                                                                                                                                                                              rlflx
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional points

                                                                                                                                                                                              points?: number

                                                                                                                                                                                              Number of points

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional points

                                                                                                                                                                                              points?: number

                                                                                                                                                                                              Number of points

                                                                                                                                                                                              Default

                                                                                                                                                                                              4
                                                                                                                                                                                              -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              blockDurationdurationexecEvenlyexecEvenlyMinDelayMskeyPrefixpoints
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              blockDurationdurationexecEvenlyexecEvenlyMinDelayMskeyPrefixpoints
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.rate_limiter.RateLimiterResult.html b/interfaces/_libp2p_utils.rate_limiter.RateLimiterResult.html index 1f502c3ee6..50b06c941d 100644 --- a/interfaces/_libp2p_utils.rate_limiter.RateLimiterResult.html +++ b/interfaces/_libp2p_utils.rate_limiter.RateLimiterResult.html @@ -1,5 +1,5 @@ -RateLimiterResult | libp2p

                                                                                                                                                                                              Interface RateLimiterResult

                                                                                                                                                                                              interface RateLimiterResult {
                                                                                                                                                                                                  consumedPoints: number;
                                                                                                                                                                                                  isFirstInDuration: boolean;
                                                                                                                                                                                                  msBeforeNext: number;
                                                                                                                                                                                                  remainingPoints: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              consumedPoints +RateLimiterResult | libp2p

                                                                                                                                                                                              Interface RateLimiterResult

                                                                                                                                                                                              interface RateLimiterResult {
                                                                                                                                                                                                  consumedPoints: number;
                                                                                                                                                                                                  isFirstInDuration: boolean;
                                                                                                                                                                                                  msBeforeNext: number;
                                                                                                                                                                                                  remainingPoints: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              consumedPoints isFirstInDuration msBeforeNext remainingPoints -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              consumedPoints

                                                                                                                                                                                              consumedPoints: number

                                                                                                                                                                                              isFirstInDuration

                                                                                                                                                                                              isFirstInDuration: boolean

                                                                                                                                                                                              msBeforeNext

                                                                                                                                                                                              msBeforeNext: number

                                                                                                                                                                                              remainingPoints

                                                                                                                                                                                              remainingPoints: number

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              consumedPointsisFirstInDurationmsBeforeNextremainingPoints
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              consumedPoints

                                                                                                                                                                                              consumedPoints: number

                                                                                                                                                                                              isFirstInDuration

                                                                                                                                                                                              isFirstInDuration: boolean

                                                                                                                                                                                              msBeforeNext

                                                                                                                                                                                              msBeforeNext: number

                                                                                                                                                                                              remainingPoints

                                                                                                                                                                                              remainingPoints: number

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              consumedPointsisFirstInDurationmsBeforeNextremainingPoints
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.rate_limiter.RateRecord.html b/interfaces/_libp2p_utils.rate_limiter.RateRecord.html index ce2f302386..c417546811 100644 --- a/interfaces/_libp2p_utils.rate_limiter.RateRecord.html +++ b/interfaces/_libp2p_utils.rate_limiter.RateRecord.html @@ -1,4 +1,4 @@ -RateRecord | libp2p

                                                                                                                                                                                              Interface RateRecord

                                                                                                                                                                                              interface RateRecord {
                                                                                                                                                                                                  expiresAt?: Date;
                                                                                                                                                                                                  timeoutId?: Timeout;
                                                                                                                                                                                                  value: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              expiresAt? +RateRecord | libp2p

                                                                                                                                                                                              Interface RateRecord

                                                                                                                                                                                              interface RateRecord {
                                                                                                                                                                                                  expiresAt?: Date;
                                                                                                                                                                                                  timeoutId?: Timeout;
                                                                                                                                                                                                  value: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              expiresAt? timeoutId? value -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional expiresAt

                                                                                                                                                                                              expiresAt?: Date

                                                                                                                                                                                              Optional timeoutId

                                                                                                                                                                                              timeoutId?: Timeout

                                                                                                                                                                                              value

                                                                                                                                                                                              value: number

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              expiresAttimeoutIdvalue
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional expiresAt

                                                                                                                                                                                              expiresAt?: Date

                                                                                                                                                                                              Optional timeoutId

                                                                                                                                                                                              timeoutId?: Timeout

                                                                                                                                                                                              value

                                                                                                                                                                                              value: number

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              expiresAttimeoutIdvalue
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.repeating_task.RepeatingTask.html b/interfaces/_libp2p_utils.repeating_task.RepeatingTask.html index a9caa07239..7e1c9a77cb 100644 --- a/interfaces/_libp2p_utils.repeating_task.RepeatingTask.html +++ b/interfaces/_libp2p_utils.repeating_task.RepeatingTask.html @@ -1,3 +1,3 @@ -RepeatingTask | libp2p

                                                                                                                                                                                              Interface RepeatingTask

                                                                                                                                                                                              interface RepeatingTask {
                                                                                                                                                                                                  start(): void;
                                                                                                                                                                                                  stop(): void;
                                                                                                                                                                                              }

                                                                                                                                                                                              Methods

                                                                                                                                                                                              start +RepeatingTask | libp2p

                                                                                                                                                                                              Interface RepeatingTask

                                                                                                                                                                                              interface RepeatingTask {
                                                                                                                                                                                                  start(): void;
                                                                                                                                                                                                  stop(): void;
                                                                                                                                                                                              }

                                                                                                                                                                                              Methods

                                                                                                                                                                                              start stop -

                                                                                                                                                                                              Methods

                                                                                                                                                                                              start

                                                                                                                                                                                              stop

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              startstop
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Methods

                                                                                                                                                                                              start

                                                                                                                                                                                              stop

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              startstop
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.repeating_task.RepeatingTaskOptions.html b/interfaces/_libp2p_utils.repeating_task.RepeatingTaskOptions.html index 0dc8347bcd..ae6879fb54 100644 --- a/interfaces/_libp2p_utils.repeating_task.RepeatingTaskOptions.html +++ b/interfaces/_libp2p_utils.repeating_task.RepeatingTaskOptions.html @@ -1,6 +1,6 @@ -RepeatingTaskOptions | libp2p

                                                                                                                                                                                              Interface RepeatingTaskOptions

                                                                                                                                                                                              interface RepeatingTaskOptions {
                                                                                                                                                                                                  runImmediately?: boolean;
                                                                                                                                                                                                  timeout?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              runImmediately? +RepeatingTaskOptions | libp2p

                                                                                                                                                                                              Interface RepeatingTaskOptions

                                                                                                                                                                                              interface RepeatingTaskOptions {
                                                                                                                                                                                                  runImmediately?: boolean;
                                                                                                                                                                                                  timeout?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              runImmediately? timeout?

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional runImmediately

                                                                                                                                                                                              runImmediately?: boolean

                                                                                                                                                                                              Whether to schedule the task to run immediately

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional timeout

                                                                                                                                                                                              timeout?: number

                                                                                                                                                                                              How long the task is allowed to run before the passed AbortSignal fires an +

                                                                                                                                                                                              Optional timeout

                                                                                                                                                                                              timeout?: number

                                                                                                                                                                                              How long the task is allowed to run before the passed AbortSignal fires an abort event

                                                                                                                                                                                              -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              runImmediatelytimeout
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              runImmediatelytimeout
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.stream_to_ma_conn.StreamProperties.html b/interfaces/_libp2p_utils.stream_to_ma_conn.StreamProperties.html index c759d19954..35764e98a0 100644 --- a/interfaces/_libp2p_utils.stream_to_ma_conn.StreamProperties.html +++ b/interfaces/_libp2p_utils.stream_to_ma_conn.StreamProperties.html @@ -1,9 +1,9 @@ -StreamProperties | libp2p

                                                                                                                                                                                              Interface StreamProperties

                                                                                                                                                                                              interface StreamProperties {
                                                                                                                                                                                                  localAddr: Multiaddr;
                                                                                                                                                                                                  logger: ComponentLogger;
                                                                                                                                                                                                  remoteAddr: Multiaddr;
                                                                                                                                                                                                  stream: Stream;
                                                                                                                                                                                                  onDataRead?(buf): void;
                                                                                                                                                                                                  onDataWrite?(buf): void;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              localAddr +StreamProperties | libp2p

                                                                                                                                                                                              Interface StreamProperties

                                                                                                                                                                                              interface StreamProperties {
                                                                                                                                                                                                  localAddr: Multiaddr;
                                                                                                                                                                                                  logger: ComponentLogger;
                                                                                                                                                                                                  remoteAddr: Multiaddr;
                                                                                                                                                                                                  stream: Stream;
                                                                                                                                                                                                  onDataRead?(buf): void;
                                                                                                                                                                                                  onDataWrite?(buf): void;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              localAddr logger remoteAddr stream

                                                                                                                                                                                              Methods

                                                                                                                                                                                              onDataRead? onDataWrite? -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              localAddr

                                                                                                                                                                                              localAddr: Multiaddr

                                                                                                                                                                                              logger

                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                              remoteAddr

                                                                                                                                                                                              remoteAddr: Multiaddr

                                                                                                                                                                                              stream

                                                                                                                                                                                              stream: Stream

                                                                                                                                                                                              Methods

                                                                                                                                                                                              Optional onDataRead

                                                                                                                                                                                              Optional onDataWrite

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              localAddrloggerremoteAddrstreamonDataReadonDataWrite
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              localAddr

                                                                                                                                                                                              localAddr: Multiaddr

                                                                                                                                                                                              logger

                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                              remoteAddr

                                                                                                                                                                                              remoteAddr: Multiaddr

                                                                                                                                                                                              stream

                                                                                                                                                                                              stream: Stream

                                                                                                                                                                                              Methods

                                                                                                                                                                                              Optional onDataRead

                                                                                                                                                                                              Optional onDataWrite

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              localAddrloggerremoteAddrstreamonDataReadonDataWrite
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.tracked_list.CreateTrackedListInit.html b/interfaces/_libp2p_utils.tracked_list.CreateTrackedListInit.html index e97bb9a493..6ac33b39a6 100644 --- a/interfaces/_libp2p_utils.tracked_list.CreateTrackedListInit.html +++ b/interfaces/_libp2p_utils.tracked_list.CreateTrackedListInit.html @@ -1,5 +1,5 @@ -CreateTrackedListInit | libp2p

                                                                                                                                                                                              Interface CreateTrackedListInit

                                                                                                                                                                                              interface CreateTrackedListInit {
                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                                  name: string;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              metrics? +CreateTrackedListInit | libp2p

                                                                                                                                                                                              Interface CreateTrackedListInit

                                                                                                                                                                                              interface CreateTrackedListInit {
                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                                  name: string;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              metrics? name

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional metrics

                                                                                                                                                                                              metrics?: Metrics

                                                                                                                                                                                              A metrics implementation

                                                                                                                                                                                              -

                                                                                                                                                                                              name

                                                                                                                                                                                              name: string

                                                                                                                                                                                              The metric name to use

                                                                                                                                                                                              -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              metricsname
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              name

                                                                                                                                                                                              name: string

                                                                                                                                                                                              The metric name to use

                                                                                                                                                                                              +

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              metricsname
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.tracked_map.CreateTrackedMapInit.html b/interfaces/_libp2p_utils.tracked_map.CreateTrackedMapInit.html index 2745de1ee8..879d044dd3 100644 --- a/interfaces/_libp2p_utils.tracked_map.CreateTrackedMapInit.html +++ b/interfaces/_libp2p_utils.tracked_map.CreateTrackedMapInit.html @@ -1,5 +1,5 @@ -CreateTrackedMapInit | libp2p

                                                                                                                                                                                              Interface CreateTrackedMapInit

                                                                                                                                                                                              interface CreateTrackedMapInit {
                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                                  name: string;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              metrics? +CreateTrackedMapInit | libp2p

                                                                                                                                                                                              Interface CreateTrackedMapInit

                                                                                                                                                                                              interface CreateTrackedMapInit {
                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                                  name: string;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              metrics? name

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional metrics

                                                                                                                                                                                              metrics?: Metrics

                                                                                                                                                                                              A metrics implementation

                                                                                                                                                                                              -

                                                                                                                                                                                              name

                                                                                                                                                                                              name: string

                                                                                                                                                                                              The metric name to use

                                                                                                                                                                                              -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              metricsname
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              name

                                                                                                                                                                                              name: string

                                                                                                                                                                                              The metric name to use

                                                                                                                                                                                              +

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              metricsname
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_utils.tracked_map.TrackedMapInit.html b/interfaces/_libp2p_utils.tracked_map.TrackedMapInit.html index 64627e57eb..46e802d3c6 100644 --- a/interfaces/_libp2p_utils.tracked_map.TrackedMapInit.html +++ b/interfaces/_libp2p_utils.tracked_map.TrackedMapInit.html @@ -1,3 +1,3 @@ -TrackedMapInit | libp2p

                                                                                                                                                                                              Interface TrackedMapInit

                                                                                                                                                                                              interface TrackedMapInit {
                                                                                                                                                                                                  metrics: Metrics;
                                                                                                                                                                                                  name: string;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              metrics +TrackedMapInit | libp2p

                                                                                                                                                                                              Interface TrackedMapInit

                                                                                                                                                                                              interface TrackedMapInit {
                                                                                                                                                                                                  metrics: Metrics;
                                                                                                                                                                                                  name: string;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              metrics name -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              metrics

                                                                                                                                                                                              metrics: Metrics

                                                                                                                                                                                              name

                                                                                                                                                                                              name: string

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              metricsname
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              metrics

                                                                                                                                                                                              metrics: Metrics

                                                                                                                                                                                              name

                                                                                                                                                                                              name: string

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              metricsname
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_webrtc.DataChannelOptions.html b/interfaces/_libp2p_webrtc.DataChannelOptions.html index d9bdc3a337..751fbd27fc 100644 --- a/interfaces/_libp2p_webrtc.DataChannelOptions.html +++ b/interfaces/_libp2p_webrtc.DataChannelOptions.html @@ -1,4 +1,4 @@ -DataChannelOptions | libp2p

                                                                                                                                                                                              Interface DataChannelOptions

                                                                                                                                                                                              interface DataChannelOptions {
                                                                                                                                                                                                  bufferedAmountLowEventTimeout?: number;
                                                                                                                                                                                                  closeTimeout?: number;
                                                                                                                                                                                                  drainTimeout?: number;
                                                                                                                                                                                                  maxBufferedAmount?: number;
                                                                                                                                                                                                  maxMessageSize?: number;
                                                                                                                                                                                                  openTimeout?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              bufferedAmountLowEventTimeout? +DataChannelOptions | libp2p

                                                                                                                                                                                              Interface DataChannelOptions

                                                                                                                                                                                              interface DataChannelOptions {
                                                                                                                                                                                                  bufferedAmountLowEventTimeout?: number;
                                                                                                                                                                                                  closeTimeout?: number;
                                                                                                                                                                                                  drainTimeout?: number;
                                                                                                                                                                                                  maxBufferedAmount?: number;
                                                                                                                                                                                                  maxMessageSize?: number;
                                                                                                                                                                                                  openTimeout?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              bufferedAmountLowEventTimeout? closeTimeout? drainTimeout? maxBufferedAmount? @@ -9,23 +9,23 @@ that event in ms

                                                                                                                                                                                              Default

                                                                                                                                                                                              30000
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional closeTimeout

                                                                                                                                                                                              closeTimeout?: number

                                                                                                                                                                                              When closing a stream we first send a FIN flag to the remote and wait +

                                                                                                                                                                                              Optional closeTimeout

                                                                                                                                                                                              closeTimeout?: number

                                                                                                                                                                                              When closing a stream we first send a FIN flag to the remote and wait for a FIN_ACK reply before closing the underlying RTCDataChannel - this controls how long we wait for the acknowledgement in ms

                                                                                                                                                                                              Default

                                                                                                                                                                                              5000
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional drainTimeout

                                                                                                                                                                                              drainTimeout?: number

                                                                                                                                                                                              When closing a stream, we wait for bufferedAmount to become 0 before +

                                                                                                                                                                                              Optional drainTimeout

                                                                                                                                                                                              drainTimeout?: number

                                                                                                                                                                                              When closing a stream, we wait for bufferedAmount to become 0 before closing the underlying RTCDataChannel - this controls how long we wait in ms

                                                                                                                                                                                              Default

                                                                                                                                                                                              30000
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional maxBufferedAmount

                                                                                                                                                                                              maxBufferedAmount?: number

                                                                                                                                                                                              If the channel's bufferedAmount grows over this amount in bytes, wait +

                                                                                                                                                                                              Optional maxBufferedAmount

                                                                                                                                                                                              maxBufferedAmount?: number

                                                                                                                                                                                              If the channel's bufferedAmount grows over this amount in bytes, wait for it to drain before sending more data

                                                                                                                                                                                              Default

                                                                                                                                                                                              16777216
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional maxMessageSize

                                                                                                                                                                                              maxMessageSize?: number

                                                                                                                                                                                              The maximum message size sendable over the channel in bytes

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional maxMessageSize

                                                                                                                                                                                              maxMessageSize?: number

                                                                                                                                                                                              The maximum message size sendable over the channel in bytes

                                                                                                                                                                                              Default

                                                                                                                                                                                              16384
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional openTimeout

                                                                                                                                                                                              openTimeout?: number

                                                                                                                                                                                              When sending the first data message, if the channel is not in the "open" +

                                                                                                                                                                                              Optional openTimeout

                                                                                                                                                                                              openTimeout?: number

                                                                                                                                                                                              When sending the first data message, if the channel is not in the "open" state, wait this long for the "open" event to fire.

                                                                                                                                                                                              -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              bufferedAmountLowEventTimeoutcloseTimeoutdrainTimeoutmaxBufferedAmountmaxMessageSizeopenTimeout
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              bufferedAmountLowEventTimeoutcloseTimeoutdrainTimeoutmaxBufferedAmountmaxMessageSizeopenTimeout
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_webrtc.WebRTCDirectTransportComponents.html b/interfaces/_libp2p_webrtc.WebRTCDirectTransportComponents.html index 85cc3079cb..93356e7ae7 100644 --- a/interfaces/_libp2p_webrtc.WebRTCDirectTransportComponents.html +++ b/interfaces/_libp2p_webrtc.WebRTCDirectTransportComponents.html @@ -1,6 +1,6 @@ WebRTCDirectTransportComponents | libp2p

                                                                                                                                                                                              Interface WebRTCDirectTransportComponents

                                                                                                                                                                                              The peer for this transport

                                                                                                                                                                                              -
                                                                                                                                                                                              interface WebRTCDirectTransportComponents {
                                                                                                                                                                                                  logger: ComponentLogger;
                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                                  peerId: PeerId;
                                                                                                                                                                                                  privateKey: PrivateKey;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger +
                                                                                                                                                                                              interface WebRTCDirectTransportComponents {
                                                                                                                                                                                                  logger: ComponentLogger;
                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                                  peerId: PeerId;
                                                                                                                                                                                                  privateKey: PrivateKey;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger metrics? peerId privateKey -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger

                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                              Optional metrics

                                                                                                                                                                                              metrics?: Metrics

                                                                                                                                                                                              peerId

                                                                                                                                                                                              peerId: PeerId

                                                                                                                                                                                              privateKey

                                                                                                                                                                                              privateKey: PrivateKey

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              loggermetricspeerIdprivateKey
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger

                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                              Optional metrics

                                                                                                                                                                                              metrics?: Metrics

                                                                                                                                                                                              peerId

                                                                                                                                                                                              peerId: PeerId

                                                                                                                                                                                              privateKey

                                                                                                                                                                                              privateKey: PrivateKey

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              loggermetricspeerIdprivateKey
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_webrtc.WebRTCTransportComponents.html b/interfaces/_libp2p_webrtc.WebRTCTransportComponents.html index 924bdaf7d5..a6b3419b84 100644 --- a/interfaces/_libp2p_webrtc.WebRTCTransportComponents.html +++ b/interfaces/_libp2p_webrtc.WebRTCTransportComponents.html @@ -1,8 +1,8 @@ -WebRTCTransportComponents | libp2p

                                                                                                                                                                                              Interface WebRTCTransportComponents

                                                                                                                                                                                              interface WebRTCTransportComponents {
                                                                                                                                                                                                  connectionManager: ConnectionManager;
                                                                                                                                                                                                  logger: ComponentLogger;
                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                                  peerId: PeerId;
                                                                                                                                                                                                  registrar: Registrar;
                                                                                                                                                                                                  transportManager: TransportManager;
                                                                                                                                                                                                  upgrader: Upgrader;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              connectionManager +WebRTCTransportComponents | libp2p

                                                                                                                                                                                              Interface WebRTCTransportComponents

                                                                                                                                                                                              interface WebRTCTransportComponents {
                                                                                                                                                                                                  connectionManager: ConnectionManager;
                                                                                                                                                                                                  logger: ComponentLogger;
                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                                  peerId: PeerId;
                                                                                                                                                                                                  registrar: Registrar;
                                                                                                                                                                                                  transportManager: TransportManager;
                                                                                                                                                                                                  upgrader: Upgrader;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              connectionManager logger metrics? peerId registrar transportManager upgrader -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              connectionManager

                                                                                                                                                                                              connectionManager: ConnectionManager

                                                                                                                                                                                              logger

                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                              Optional metrics

                                                                                                                                                                                              metrics?: Metrics

                                                                                                                                                                                              peerId

                                                                                                                                                                                              peerId: PeerId

                                                                                                                                                                                              registrar

                                                                                                                                                                                              registrar: Registrar

                                                                                                                                                                                              transportManager

                                                                                                                                                                                              transportManager: TransportManager

                                                                                                                                                                                              upgrader

                                                                                                                                                                                              upgrader: Upgrader

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              connectionManagerloggermetricspeerIdregistrartransportManagerupgrader
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              connectionManager

                                                                                                                                                                                              connectionManager: ConnectionManager

                                                                                                                                                                                              logger

                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                              Optional metrics

                                                                                                                                                                                              metrics?: Metrics

                                                                                                                                                                                              peerId

                                                                                                                                                                                              peerId: PeerId

                                                                                                                                                                                              registrar

                                                                                                                                                                                              registrar: Registrar

                                                                                                                                                                                              transportManager

                                                                                                                                                                                              transportManager: TransportManager

                                                                                                                                                                                              upgrader

                                                                                                                                                                                              upgrader: Upgrader

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              connectionManagerloggermetricspeerIdregistrartransportManagerupgrader
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_webrtc.WebRTCTransportDirectInit.html b/interfaces/_libp2p_webrtc.WebRTCTransportDirectInit.html index 71f2c2275c..9d62fe438a 100644 --- a/interfaces/_libp2p_webrtc.WebRTCTransportDirectInit.html +++ b/interfaces/_libp2p_webrtc.WebRTCTransportDirectInit.html @@ -1,3 +1,3 @@ -WebRTCTransportDirectInit | libp2p

                                                                                                                                                                                              Interface WebRTCTransportDirectInit

                                                                                                                                                                                              interface WebRTCTransportDirectInit {
                                                                                                                                                                                                  dataChannel?: DataChannelOptions;
                                                                                                                                                                                                  rtcConfiguration?: RTCConfiguration | (() => RTCConfiguration | Promise<RTCConfiguration>);
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              dataChannel? +WebRTCTransportDirectInit | libp2p

                                                                                                                                                                                              Interface WebRTCTransportDirectInit

                                                                                                                                                                                              interface WebRTCTransportDirectInit {
                                                                                                                                                                                                  dataChannel?: DataChannelOptions;
                                                                                                                                                                                                  rtcConfiguration?: RTCConfiguration | (() => RTCConfiguration | Promise<RTCConfiguration>);
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              dataChannel? rtcConfiguration? -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional dataChannel

                                                                                                                                                                                              dataChannel?: DataChannelOptions

                                                                                                                                                                                              Optional rtcConfiguration

                                                                                                                                                                                              rtcConfiguration?: RTCConfiguration | (() => RTCConfiguration | Promise<RTCConfiguration>)

                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                • (): RTCConfiguration | Promise<RTCConfiguration>

                                                                                                                                                                                                • Returns RTCConfiguration | Promise<RTCConfiguration>

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              dataChannelrtcConfiguration
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional dataChannel

                                                                                                                                                                                              dataChannel?: DataChannelOptions

                                                                                                                                                                                              Optional rtcConfiguration

                                                                                                                                                                                              rtcConfiguration?: RTCConfiguration | (() => RTCConfiguration | Promise<RTCConfiguration>)

                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                • (): RTCConfiguration | Promise<RTCConfiguration>

                                                                                                                                                                                                • Returns RTCConfiguration | Promise<RTCConfiguration>

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              dataChannelrtcConfiguration
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_webrtc.WebRTCTransportInit.html b/interfaces/_libp2p_webrtc.WebRTCTransportInit.html index 6dcd9d74c9..467c437e20 100644 --- a/interfaces/_libp2p_webrtc.WebRTCTransportInit.html +++ b/interfaces/_libp2p_webrtc.WebRTCTransportInit.html @@ -1,7 +1,7 @@ -WebRTCTransportInit | libp2p

                                                                                                                                                                                              Interface WebRTCTransportInit

                                                                                                                                                                                              interface WebRTCTransportInit {
                                                                                                                                                                                                  dataChannel?: DataChannelOptions;
                                                                                                                                                                                                  inboundConnectionTimeout?: number;
                                                                                                                                                                                                  rtcConfiguration?: RTCConfiguration | (() => RTCConfiguration | Promise<RTCConfiguration>);
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              dataChannel? +WebRTCTransportInit | libp2p

                                                                                                                                                                                              Interface WebRTCTransportInit

                                                                                                                                                                                              interface WebRTCTransportInit {
                                                                                                                                                                                                  dataChannel?: DataChannelOptions;
                                                                                                                                                                                                  inboundConnectionTimeout?: number;
                                                                                                                                                                                                  rtcConfiguration?: RTCConfiguration | (() => RTCConfiguration | Promise<RTCConfiguration>);
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              dataChannel? inboundConnectionTimeout? rtcConfiguration? -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional dataChannel

                                                                                                                                                                                              dataChannel?: DataChannelOptions

                                                                                                                                                                                              Optional inboundConnectionTimeout

                                                                                                                                                                                              inboundConnectionTimeout?: number

                                                                                                                                                                                              Inbound connections must complete the upgrade within this many ms

                                                                                                                                                                                              +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional dataChannel

                                                                                                                                                                                              dataChannel?: DataChannelOptions

                                                                                                                                                                                              Optional inboundConnectionTimeout

                                                                                                                                                                                              inboundConnectionTimeout?: number

                                                                                                                                                                                              Inbound connections must complete the upgrade within this many ms

                                                                                                                                                                                              Default

                                                                                                                                                                                              30000
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional rtcConfiguration

                                                                                                                                                                                              rtcConfiguration?: RTCConfiguration | (() => RTCConfiguration | Promise<RTCConfiguration>)

                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                • (): RTCConfiguration | Promise<RTCConfiguration>

                                                                                                                                                                                                • Returns RTCConfiguration | Promise<RTCConfiguration>

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              dataChannelinboundConnectionTimeoutrtcConfiguration
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Optional rtcConfiguration

                                                                                                                                                                                              rtcConfiguration?: RTCConfiguration | (() => RTCConfiguration | Promise<RTCConfiguration>)

                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                • (): RTCConfiguration | Promise<RTCConfiguration>

                                                                                                                                                                                                • Returns RTCConfiguration | Promise<RTCConfiguration>

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              dataChannelinboundConnectionTimeoutrtcConfiguration
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_websockets.index.WebSocketsComponents.html b/interfaces/_libp2p_websockets.index.WebSocketsComponents.html index b0adabd389..f21126b01b 100644 --- a/interfaces/_libp2p_websockets.index.WebSocketsComponents.html +++ b/interfaces/_libp2p_websockets.index.WebSocketsComponents.html @@ -1,4 +1,4 @@ -WebSocketsComponents | libp2p

                                                                                                                                                                                              Interface WebSocketsComponents

                                                                                                                                                                                              interface WebSocketsComponents {
                                                                                                                                                                                                  events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                                                                                                                                                                  logger: ComponentLogger;
                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              events +WebSocketsComponents | libp2p

                                                                                                                                                                                              Interface WebSocketsComponents

                                                                                                                                                                                              interface WebSocketsComponents {
                                                                                                                                                                                                  events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                                                                                                                                                                  logger: ComponentLogger;
                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              events logger metrics? -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              events

                                                                                                                                                                                              events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                                                                                                                                                                              logger

                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                              Optional metrics

                                                                                                                                                                                              metrics?: Metrics

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              eventsloggermetrics
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              events

                                                                                                                                                                                              events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                                                                                                                                                                              logger

                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                              Optional metrics

                                                                                                                                                                                              metrics?: Metrics

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              eventsloggermetrics
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_websockets.index.WebSocketsInit.html b/interfaces/_libp2p_websockets.index.WebSocketsInit.html index 07c1230499..bebc38339a 100644 --- a/interfaces/_libp2p_websockets.index.WebSocketsInit.html +++ b/interfaces/_libp2p_websockets.index.WebSocketsInit.html @@ -2,7 +2,7 @@ the optional signal property.

                                                                                                                                                                                              Example

                                                                                                                                                                                              const controller = new AbortController()

                                                                                                                                                                                              aLongRunningOperation({
                                                                                                                                                                                                signal: controller.signal
                                                                                                                                                                                              })

                                                                                                                                                                                              // later

                                                                                                                                                                                              controller.abort()
                                                                                                                                                                                              -
                                                                                                                                                                                              interface WebSocketsInit {
                                                                                                                                                                                                  closeOnEnd?: boolean;
                                                                                                                                                                                                  filter?: MultiaddrFilter;
                                                                                                                                                                                                  http?: ServerOptions<typeof IncomingMessage, typeof ServerResponse>;
                                                                                                                                                                                                  https?: ServerOptions<typeof IncomingMessage, typeof ServerResponse>;
                                                                                                                                                                                                  inboundConnectionUpgradeTimeout?: number;
                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                                  websocket?: ClientOptions;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                              Properties

                                                                                                                                                                                              closeOnEnd? +
                                                                                                                                                                                              interface WebSocketsInit {
                                                                                                                                                                                                  closeOnEnd?: boolean;
                                                                                                                                                                                                  filter?: MultiaddrFilter;
                                                                                                                                                                                                  http?: ServerOptions<typeof IncomingMessage, typeof ServerResponse>;
                                                                                                                                                                                                  https?: ServerOptions<typeof IncomingMessage, typeof ServerResponse>;
                                                                                                                                                                                                  inboundConnectionUpgradeTimeout?: number;
                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                                  websocket?: ClientOptions;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                              Properties

                                                                                                                                                                                              closeOnEnd? filter? http? https? @@ -10,11 +10,11 @@ signal? websocket?

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional closeOnEnd

                                                                                                                                                                                              closeOnEnd?: boolean

                                                                                                                                                                                              Optional filter

                                                                                                                                                                                              filter?: MultiaddrFilter

                                                                                                                                                                                              Deprecated

                                                                                                                                                                                              Use a ConnectionGater instead

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional http

                                                                                                                                                                                              http?: ServerOptions<typeof IncomingMessage, typeof ServerResponse>

                                                                                                                                                                                              Options used to create the HTTP server

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional https

                                                                                                                                                                                              https?: ServerOptions<typeof IncomingMessage, typeof ServerResponse>

                                                                                                                                                                                              Options used to create the HTTPs server. options.http will be used if +

                                                                                                                                                                                              Optional http

                                                                                                                                                                                              http?: ServerOptions<typeof IncomingMessage, typeof ServerResponse>

                                                                                                                                                                                              Options used to create the HTTP server

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional https

                                                                                                                                                                                              https?: ServerOptions<typeof IncomingMessage, typeof ServerResponse>

                                                                                                                                                                                              Options used to create the HTTPs server. options.http will be used if unspecified.

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional inboundConnectionUpgradeTimeout

                                                                                                                                                                                              inboundConnectionUpgradeTimeout?: number

                                                                                                                                                                                              Inbound connections must complete their upgrade within this many ms

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional inboundConnectionUpgradeTimeout

                                                                                                                                                                                              inboundConnectionUpgradeTimeout?: number

                                                                                                                                                                                              Inbound connections must complete their upgrade within this many ms

                                                                                                                                                                                              Default

                                                                                                                                                                                              5000
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional signal

                                                                                                                                                                                              signal?: AbortSignal

                                                                                                                                                                                              Optional websocket

                                                                                                                                                                                              websocket?: ClientOptions

                                                                                                                                                                                              Options used to create WebSockets

                                                                                                                                                                                              -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              closeOnEndfilterhttphttpsinboundConnectionUpgradeTimeoutsignalwebsocket
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Optional signal

                                                                                                                                                                                              signal?: AbortSignal

                                                                                                                                                                                              Optional websocket

                                                                                                                                                                                              websocket?: ClientOptions

                                                                                                                                                                                              Options used to create WebSockets

                                                                                                                                                                                              +

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              closeOnEndfilterhttphttpsinboundConnectionUpgradeTimeoutsignalwebsocket
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_websockets.index.WebSocketsMetrics.html b/interfaces/_libp2p_websockets.index.WebSocketsMetrics.html index 9ac107afff..8ebb07c512 100644 --- a/interfaces/_libp2p_websockets.index.WebSocketsMetrics.html +++ b/interfaces/_libp2p_websockets.index.WebSocketsMetrics.html @@ -1,2 +1,2 @@ -WebSocketsMetrics | libp2p

                                                                                                                                                                                              Interface WebSocketsMetrics

                                                                                                                                                                                              interface WebSocketsMetrics {
                                                                                                                                                                                                  dialerEvents: CounterGroup<any>;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              dialerEvents -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              dialerEvents

                                                                                                                                                                                              dialerEvents: CounterGroup<any>

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              dialerEvents
                                                                                                                                                                                              \ No newline at end of file +WebSocketsMetrics | libp2p

                                                                                                                                                                                              Interface WebSocketsMetrics

                                                                                                                                                                                              interface WebSocketsMetrics {
                                                                                                                                                                                                  dialerEvents: CounterGroup<any>;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              dialerEvents +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              dialerEvents

                                                                                                                                                                                              dialerEvents: CounterGroup<any>

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              dialerEvents
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_webtransport.WebTransportCertificate.html b/interfaces/_libp2p_webtransport.WebTransportCertificate.html index df88c3df44..4ea5269182 100644 --- a/interfaces/_libp2p_webtransport.WebTransportCertificate.html +++ b/interfaces/_libp2p_webtransport.WebTransportCertificate.html @@ -1,6 +1,6 @@ WebTransportCertificate | libp2p

                                                                                                                                                                                              Interface WebTransportCertificate

                                                                                                                                                                                              PEM format server certificate and private key

                                                                                                                                                                                              -
                                                                                                                                                                                              interface WebTransportCertificate {
                                                                                                                                                                                                  hash: MultihashDigest<number>;
                                                                                                                                                                                                  pem: string;
                                                                                                                                                                                                  privateKey: string;
                                                                                                                                                                                                  secret: string;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              hash +
                                                                                                                                                                                              interface WebTransportCertificate {
                                                                                                                                                                                                  hash: MultihashDigest<number>;
                                                                                                                                                                                                  pem: string;
                                                                                                                                                                                                  privateKey: string;
                                                                                                                                                                                                  secret: string;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              hash pem privateKey secret -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              hash

                                                                                                                                                                                              hash: MultihashDigest<number>

                                                                                                                                                                                              pem

                                                                                                                                                                                              pem: string

                                                                                                                                                                                              privateKey

                                                                                                                                                                                              privateKey: string

                                                                                                                                                                                              secret

                                                                                                                                                                                              secret: string

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              hashpemprivateKeysecret
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              hash

                                                                                                                                                                                              hash: MultihashDigest<number>

                                                                                                                                                                                              pem

                                                                                                                                                                                              pem: string

                                                                                                                                                                                              privateKey

                                                                                                                                                                                              privateKey: string

                                                                                                                                                                                              secret

                                                                                                                                                                                              secret: string

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              hashpemprivateKeysecret
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_webtransport.WebTransportComponents.html b/interfaces/_libp2p_webtransport.WebTransportComponents.html index d486126320..783381f1d0 100644 --- a/interfaces/_libp2p_webtransport.WebTransportComponents.html +++ b/interfaces/_libp2p_webtransport.WebTransportComponents.html @@ -1,5 +1,5 @@ -WebTransportComponents | libp2p

                                                                                                                                                                                              Interface WebTransportComponents

                                                                                                                                                                                              interface WebTransportComponents {
                                                                                                                                                                                                  logger: ComponentLogger;
                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                                  peerId: PeerId;
                                                                                                                                                                                                  privateKey: PrivateKey;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger +WebTransportComponents | libp2p

                                                                                                                                                                                              Interface WebTransportComponents

                                                                                                                                                                                              interface WebTransportComponents {
                                                                                                                                                                                                  logger: ComponentLogger;
                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                                  peerId: PeerId;
                                                                                                                                                                                                  privateKey: PrivateKey;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger metrics? peerId privateKey -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger

                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                              Optional metrics

                                                                                                                                                                                              metrics?: Metrics

                                                                                                                                                                                              peerId

                                                                                                                                                                                              peerId: PeerId

                                                                                                                                                                                              privateKey

                                                                                                                                                                                              privateKey: PrivateKey

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              loggermetricspeerIdprivateKey
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              logger

                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                              Optional metrics

                                                                                                                                                                                              metrics?: Metrics

                                                                                                                                                                                              peerId

                                                                                                                                                                                              peerId: PeerId

                                                                                                                                                                                              privateKey

                                                                                                                                                                                              privateKey: PrivateKey

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              loggermetricspeerIdprivateKey
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_webtransport.WebTransportInit.html b/interfaces/_libp2p_webtransport.WebTransportInit.html index 7cb15a1bb6..8a77d3f38d 100644 --- a/interfaces/_libp2p_webtransport.WebTransportInit.html +++ b/interfaces/_libp2p_webtransport.WebTransportInit.html @@ -1,3 +1,3 @@ -WebTransportInit | libp2p

                                                                                                                                                                                              Interface WebTransportInit

                                                                                                                                                                                              interface WebTransportInit {
                                                                                                                                                                                                  certificates?: WebTransportCertificate[];
                                                                                                                                                                                                  maxInboundStreams?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              certificates? +WebTransportInit | libp2p

                                                                                                                                                                                              Interface WebTransportInit

                                                                                                                                                                                              interface WebTransportInit {
                                                                                                                                                                                                  certificates?: WebTransportCertificate[];
                                                                                                                                                                                                  maxInboundStreams?: number;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              certificates? maxInboundStreams? -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional certificates

                                                                                                                                                                                              certificates?: WebTransportCertificate[]

                                                                                                                                                                                              Optional maxInboundStreams

                                                                                                                                                                                              maxInboundStreams?: number

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              certificatesmaxInboundStreams
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional certificates

                                                                                                                                                                                              certificates?: WebTransportCertificate[]

                                                                                                                                                                                              Optional maxInboundStreams

                                                                                                                                                                                              maxInboundStreams?: number

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              certificatesmaxInboundStreams
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/_libp2p_webtransport.WebTransportMetrics.html b/interfaces/_libp2p_webtransport.WebTransportMetrics.html index cd140b759f..fc09b4fc33 100644 --- a/interfaces/_libp2p_webtransport.WebTransportMetrics.html +++ b/interfaces/_libp2p_webtransport.WebTransportMetrics.html @@ -1,2 +1,2 @@ -WebTransportMetrics | libp2p

                                                                                                                                                                                              Interface WebTransportMetrics

                                                                                                                                                                                              interface WebTransportMetrics {
                                                                                                                                                                                                  dialerEvents: CounterGroup<any>;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              dialerEvents -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              dialerEvents

                                                                                                                                                                                              dialerEvents: CounterGroup<any>

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              dialerEvents
                                                                                                                                                                                              \ No newline at end of file +WebTransportMetrics | libp2p

                                                                                                                                                                                              Interface WebTransportMetrics

                                                                                                                                                                                              interface WebTransportMetrics {
                                                                                                                                                                                                  dialerEvents: CounterGroup<any>;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              dialerEvents +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              dialerEvents

                                                                                                                                                                                              dialerEvents: CounterGroup<any>

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              dialerEvents
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/libp2p.index.AddressFilter.html b/interfaces/libp2p.index.AddressFilter.html index 94d97c2668..ab6a91553f 100644 --- a/interfaces/libp2p.index.AddressFilter.html +++ b/interfaces/libp2p.index.AddressFilter.html @@ -1,3 +1,3 @@ AddressFilter | libp2p

                                                                                                                                                                                              Interface AddressFilter

                                                                                                                                                                                              A function that takes a list of multiaddrs and returns a list to announce

                                                                                                                                                                                              -
                                                                                                                                                                                              interface AddressFilter ((addrs) => Multiaddr[])

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              \ No newline at end of file +
                                                                                                                                                                                              interface AddressFilter ((addrs) => Multiaddr[])

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/libp2p.index.AddressManagerInit.html b/interfaces/libp2p.index.AddressManagerInit.html index 81e2697dfe..0c6a88d6fd 100644 --- a/interfaces/libp2p.index.AddressManagerInit.html +++ b/interfaces/libp2p.index.AddressManagerInit.html @@ -1,4 +1,4 @@ -AddressManagerInit | libp2p

                                                                                                                                                                                              Interface AddressManagerInit

                                                                                                                                                                                              interface AddressManagerInit {
                                                                                                                                                                                                  addressVerificationRetry?: number;
                                                                                                                                                                                                  addressVerificationTTL?: number;
                                                                                                                                                                                                  announce?: string[];
                                                                                                                                                                                                  announceFilter?: AddressFilter;
                                                                                                                                                                                                  appendAnnounce?: string[];
                                                                                                                                                                                                  listen?: string[];
                                                                                                                                                                                                  maxObservedAddresses?: number;
                                                                                                                                                                                                  noAnnounce?: string[];
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              addressVerificationRetry? +AddressManagerInit | libp2p

                                                                                                                                                                                              Interface AddressManagerInit

                                                                                                                                                                                              interface AddressManagerInit {
                                                                                                                                                                                                  addressVerificationRetry?: number;
                                                                                                                                                                                                  addressVerificationTTL?: number;
                                                                                                                                                                                                  announce?: string[];
                                                                                                                                                                                                  announceFilter?: AddressFilter;
                                                                                                                                                                                                  appendAnnounce?: string[];
                                                                                                                                                                                                  listen?: string[];
                                                                                                                                                                                                  maxObservedAddresses?: number;
                                                                                                                                                                                                  noAnnounce?: string[];
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              addressVerificationRetry? addressVerificationTTL? announce? announceFilter? @@ -12,16 +12,16 @@ configured.

                                                                                                                                                                                              Default

                                                                                                                                                                                              300_000
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional addressVerificationTTL

                                                                                                                                                                                              addressVerificationTTL?: number

                                                                                                                                                                                              How long before each public address should be reverified in ms.

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional addressVerificationTTL

                                                                                                                                                                                              addressVerificationTTL?: number

                                                                                                                                                                                              How long before each public address should be reverified in ms.

                                                                                                                                                                                              Requires @libp2p/autonat or some other verification method to be configured.

                                                                                                                                                                                              Default

                                                                                                                                                                                              600_000
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional announce

                                                                                                                                                                                              announce?: string[]

                                                                                                                                                                                              A list of string multiaddrs to use instead of those reported by transports

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional announceFilter

                                                                                                                                                                                              announceFilter?: AddressFilter

                                                                                                                                                                                              Pass an function in this field to override the list of addresses +

                                                                                                                                                                                              Optional announce

                                                                                                                                                                                              announce?: string[]

                                                                                                                                                                                              A list of string multiaddrs to use instead of those reported by transports

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional announceFilter

                                                                                                                                                                                              announceFilter?: AddressFilter

                                                                                                                                                                                              Pass an function in this field to override the list of addresses that are announced to the network

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional appendAnnounce

                                                                                                                                                                                              appendAnnounce?: string[]

                                                                                                                                                                                              A list of string multiaddrs to add to the list of announced addresses

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional listen

                                                                                                                                                                                              listen?: string[]

                                                                                                                                                                                              A list of string multiaddrs to listen on

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional maxObservedAddresses

                                                                                                                                                                                              maxObservedAddresses?: number

                                                                                                                                                                                              Limits the number of observed addresses we will store

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional noAnnounce

                                                                                                                                                                                              noAnnounce?: string[]

                                                                                                                                                                                              A list of string multiaddrs string to never announce

                                                                                                                                                                                              -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              addressVerificationRetryaddressVerificationTTLannounceannounceFilterappendAnnouncelistenmaxObservedAddressesnoAnnounce
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Optional appendAnnounce

                                                                                                                                                                                              appendAnnounce?: string[]

                                                                                                                                                                                              A list of string multiaddrs to add to the list of announced addresses

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional listen

                                                                                                                                                                                              listen?: string[]

                                                                                                                                                                                              A list of string multiaddrs to listen on

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional maxObservedAddresses

                                                                                                                                                                                              maxObservedAddresses?: number

                                                                                                                                                                                              Limits the number of observed addresses we will store

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional noAnnounce

                                                                                                                                                                                              noAnnounce?: string[]

                                                                                                                                                                                              A list of string multiaddrs string to never announce

                                                                                                                                                                                              +

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              addressVerificationRetryaddressVerificationTTLannounceannounceFilterappendAnnouncelistenmaxObservedAddressesnoAnnounce
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/libp2p.index.ConnectionManagerInit.html b/interfaces/libp2p.index.ConnectionManagerInit.html index 4298a64a44..429cc4260b 100644 --- a/interfaces/libp2p.index.ConnectionManagerInit.html +++ b/interfaces/libp2p.index.ConnectionManagerInit.html @@ -1,4 +1,4 @@ -ConnectionManagerInit | libp2p

                                                                                                                                                                                              Interface ConnectionManagerInit

                                                                                                                                                                                              interface ConnectionManagerInit {
                                                                                                                                                                                                  addressSorter?: AddressSorter;
                                                                                                                                                                                                  allow?: string[];
                                                                                                                                                                                                  deny?: string[];
                                                                                                                                                                                                  dialTimeout?: number;
                                                                                                                                                                                                  inboundConnectionThreshold?: number;
                                                                                                                                                                                                  inboundUpgradeTimeout?: number;
                                                                                                                                                                                                  maxConnections?: number;
                                                                                                                                                                                                  maxDialQueueLength?: number;
                                                                                                                                                                                                  maxIncomingPendingConnections?: number;
                                                                                                                                                                                                  maxParallelDials?: number;
                                                                                                                                                                                                  maxParallelReconnects?: number;
                                                                                                                                                                                                  maxPeerAddrsToDial?: number;
                                                                                                                                                                                                  outboundUpgradeTimeout?: number;
                                                                                                                                                                                                  protocolNegotiationTimeout?: number;
                                                                                                                                                                                                  reconnectBackoffFactor?: number;
                                                                                                                                                                                                  reconnectRetries?: number;
                                                                                                                                                                                                  reconnectRetryInterval?: number;
                                                                                                                                                                                                  resolvers?: Record<string, Resolver<AbortOptions>>;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              addressSorter? +ConnectionManagerInit | libp2p

                                                                                                                                                                                              Interface ConnectionManagerInit

                                                                                                                                                                                              interface ConnectionManagerInit {
                                                                                                                                                                                                  addressSorter?: AddressSorter;
                                                                                                                                                                                                  allow?: string[];
                                                                                                                                                                                                  deny?: string[];
                                                                                                                                                                                                  dialTimeout?: number;
                                                                                                                                                                                                  inboundConnectionThreshold?: number;
                                                                                                                                                                                                  inboundUpgradeTimeout?: number;
                                                                                                                                                                                                  maxConnections?: number;
                                                                                                                                                                                                  maxDialQueueLength?: number;
                                                                                                                                                                                                  maxIncomingPendingConnections?: number;
                                                                                                                                                                                                  maxParallelDials?: number;
                                                                                                                                                                                                  maxParallelReconnects?: number;
                                                                                                                                                                                                  maxPeerAddrsToDial?: number;
                                                                                                                                                                                                  outboundUpgradeTimeout?: number;
                                                                                                                                                                                                  protocolNegotiationTimeout?: number;
                                                                                                                                                                                                  reconnectBackoffFactor?: number;
                                                                                                                                                                                                  reconnectRetries?: number;
                                                                                                                                                                                                  reconnectRetryInterval?: number;
                                                                                                                                                                                                  resolvers?: Record<string, Resolver<AbortOptions>>;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              addressSorter? allow? deny? dialTimeout? @@ -18,66 +18,66 @@ resolvers?

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional addressSorter

                                                                                                                                                                                              addressSorter?: AddressSorter

                                                                                                                                                                                              Sort the known addresses of a peer before trying to dial, By default public addresses will be dialled before private (e.g. loopback or LAN) addresses.

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional allow

                                                                                                                                                                                              allow?: string[]

                                                                                                                                                                                              A list of multiaddrs that will always be allowed (except if they are in the +

                                                                                                                                                                                              Optional allow

                                                                                                                                                                                              allow?: string[]

                                                                                                                                                                                              A list of multiaddrs that will always be allowed (except if they are in the deny list) to open connections to this node even if we've reached maxConnections

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional deny

                                                                                                                                                                                              deny?: string[]

                                                                                                                                                                                              A list of multiaddrs that will never be allowed to open connections to +

                                                                                                                                                                                              Optional deny

                                                                                                                                                                                              deny?: string[]

                                                                                                                                                                                              A list of multiaddrs that will never be allowed to open connections to this node under any circumstances

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional dialTimeout

                                                                                                                                                                                              dialTimeout?: number

                                                                                                                                                                                              How long a dial attempt is allowed to take, including DNS resolution +

                                                                                                                                                                                              Optional dialTimeout

                                                                                                                                                                                              dialTimeout?: number

                                                                                                                                                                                              How long a dial attempt is allowed to take, including DNS resolution of the multiaddr, opening a socket and upgrading it to a Connection.

                                                                                                                                                                                              Default

                                                                                                                                                                                              5000
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional inboundConnectionThreshold

                                                                                                                                                                                              inboundConnectionThreshold?: number

                                                                                                                                                                                              If more than this many connections are opened per second by a single +

                                                                                                                                                                                              Optional inboundConnectionThreshold

                                                                                                                                                                                              inboundConnectionThreshold?: number

                                                                                                                                                                                              If more than this many connections are opened per second by a single host, reject subsequent connections.

                                                                                                                                                                                              Default

                                                                                                                                                                                              5
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional inboundUpgradeTimeout

                                                                                                                                                                                              inboundUpgradeTimeout?: number

                                                                                                                                                                                              When a new incoming connection is opened, the upgrade process (e.g. +

                                                                                                                                                                                              Optional inboundUpgradeTimeout

                                                                                                                                                                                              inboundUpgradeTimeout?: number

                                                                                                                                                                                              When a new incoming connection is opened, the upgrade process (e.g. protect, encrypt, multiplex etc) must complete within this number of ms.

                                                                                                                                                                                              Default

                                                                                                                                                                                              3000
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional maxConnections

                                                                                                                                                                                              maxConnections?: number

                                                                                                                                                                                              The maximum number of connections libp2p is willing to have before it +

                                                                                                                                                                                              Optional maxConnections

                                                                                                                                                                                              maxConnections?: number

                                                                                                                                                                                              The maximum number of connections libp2p is willing to have before it starts pruning connections to reduce resource usage.

                                                                                                                                                                                              Default

                                                                                                                                                                                              300/100
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional maxDialQueueLength

                                                                                                                                                                                              maxDialQueueLength?: number

                                                                                                                                                                                              The maximum size the dial queue is allowed to grow to. Promises returned +

                                                                                                                                                                                              Optional maxDialQueueLength

                                                                                                                                                                                              maxDialQueueLength?: number

                                                                                                                                                                                              The maximum size the dial queue is allowed to grow to. Promises returned when dialing peers after this limit is reached will not resolve until the queue size falls beneath this size.

                                                                                                                                                                                              Default

                                                                                                                                                                                              500
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional maxIncomingPendingConnections

                                                                                                                                                                                              maxIncomingPendingConnections?: number

                                                                                                                                                                                              The maximum number of parallel incoming connections allowed that have yet +

                                                                                                                                                                                              Optional maxIncomingPendingConnections

                                                                                                                                                                                              maxIncomingPendingConnections?: number

                                                                                                                                                                                              The maximum number of parallel incoming connections allowed that have yet to complete the connection upgrade - e.g. choosing connection encryption, muxer, etc.

                                                                                                                                                                                              Default

                                                                                                                                                                                              10
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional maxParallelDials

                                                                                                                                                                                              maxParallelDials?: number

                                                                                                                                                                                              The maximum number of dials across all peers to execute in parallel.

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional maxParallelDials

                                                                                                                                                                                              maxParallelDials?: number

                                                                                                                                                                                              The maximum number of dials across all peers to execute in parallel.

                                                                                                                                                                                              Default

                                                                                                                                                                                              100/50
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional maxParallelReconnects

                                                                                                                                                                                              maxParallelReconnects?: number

                                                                                                                                                                                              When a peers tagged with KEEP_ALIVE disconnect, reconnect to this many at +

                                                                                                                                                                                              Optional maxParallelReconnects

                                                                                                                                                                                              maxParallelReconnects?: number

                                                                                                                                                                                              When a peers tagged with KEEP_ALIVE disconnect, reconnect to this many at once.

                                                                                                                                                                                              Default

                                                                                                                                                                                              5
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional maxPeerAddrsToDial

                                                                                                                                                                                              maxPeerAddrsToDial?: number

                                                                                                                                                                                              Maximum number of addresses allowed for a given peer before giving up

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional maxPeerAddrsToDial

                                                                                                                                                                                              maxPeerAddrsToDial?: number

                                                                                                                                                                                              Maximum number of addresses allowed for a given peer before giving up

                                                                                                                                                                                              Default

                                                                                                                                                                                              25
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional outboundUpgradeTimeout

                                                                                                                                                                                              outboundUpgradeTimeout?: number

                                                                                                                                                                                              When a new outbound connection is opened, the upgrade process (e.g. +

                                                                                                                                                                                              Optional outboundUpgradeTimeout

                                                                                                                                                                                              outboundUpgradeTimeout?: number

                                                                                                                                                                                              When a new outbound connection is opened, the upgrade process (e.g. protect, encrypt, multiplex etc) must complete within this number of ms.

                                                                                                                                                                                              Default

                                                                                                                                                                                              3000
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional protocolNegotiationTimeout

                                                                                                                                                                                              protocolNegotiationTimeout?: number

                                                                                                                                                                                              Protocol negotiation must complete within this number of ms

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional protocolNegotiationTimeout

                                                                                                                                                                                              protocolNegotiationTimeout?: number

                                                                                                                                                                                              Protocol negotiation must complete within this number of ms

                                                                                                                                                                                              Default

                                                                                                                                                                                              2000
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional reconnectBackoffFactor

                                                                                                                                                                                              reconnectBackoffFactor?: number

                                                                                                                                                                                              When a peer tagged with KEEP_ALIVE disconnects, apply this multiplication +

                                                                                                                                                                                              Optional reconnectBackoffFactor

                                                                                                                                                                                              reconnectBackoffFactor?: number

                                                                                                                                                                                              When a peer tagged with KEEP_ALIVE disconnects, apply this multiplication factor to the time interval between each retry.

                                                                                                                                                                                              Default

                                                                                                                                                                                              2
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional reconnectRetries

                                                                                                                                                                                              reconnectRetries?: number

                                                                                                                                                                                              When a peer tagged with KEEP_ALIVE disconnects, attempt to redial them +

                                                                                                                                                                                              Optional reconnectRetries

                                                                                                                                                                                              reconnectRetries?: number

                                                                                                                                                                                              When a peer tagged with KEEP_ALIVE disconnects, attempt to redial them this many times.

                                                                                                                                                                                              Default

                                                                                                                                                                                              5
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional reconnectRetryInterval

                                                                                                                                                                                              reconnectRetryInterval?: number

                                                                                                                                                                                              When a peer tagged with KEEP_ALIVE disconnects, wait this long between +

                                                                                                                                                                                              Optional reconnectRetryInterval

                                                                                                                                                                                              reconnectRetryInterval?: number

                                                                                                                                                                                              When a peer tagged with KEEP_ALIVE disconnects, wait this long between each retry. Note this will be multiplied by reconnectFactor to create an increasing retry backoff.

                                                                                                                                                                                              Default

                                                                                                                                                                                              1000
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional resolvers

                                                                                                                                                                                              resolvers?: Record<string, Resolver<AbortOptions>>

                                                                                                                                                                                              Multiaddr resolvers to use when dialling

                                                                                                                                                                                              -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              addressSorterallowdenydialTimeoutinboundConnectionThresholdinboundUpgradeTimeoutmaxConnectionsmaxDialQueueLengthmaxIncomingPendingConnectionsmaxParallelDialsmaxParallelReconnectsmaxPeerAddrsToDialoutboundUpgradeTimeoutprotocolNegotiationTimeoutreconnectBackoffFactorreconnectRetriesreconnectRetryIntervalresolvers
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Optional resolvers

                                                                                                                                                                                              resolvers?: Record<string, Resolver<AbortOptions>>

                                                                                                                                                                                              Multiaddr resolvers to use when dialling

                                                                                                                                                                                              +

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              addressSorterallowdenydialTimeoutinboundConnectionThresholdinboundUpgradeTimeoutmaxConnectionsmaxDialQueueLengthmaxIncomingPendingConnectionsmaxParallelDialsmaxParallelReconnectsmaxPeerAddrsToDialoutboundUpgradeTimeoutprotocolNegotiationTimeoutreconnectBackoffFactorreconnectRetriesreconnectRetryIntervalresolvers
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/libp2p.index.ConnectionMonitorInit.html b/interfaces/libp2p.index.ConnectionMonitorInit.html index c5c5102abd..b11aa4f9ac 100644 --- a/interfaces/libp2p.index.ConnectionMonitorInit.html +++ b/interfaces/libp2p.index.ConnectionMonitorInit.html @@ -1,4 +1,4 @@ -ConnectionMonitorInit | libp2p

                                                                                                                                                                                              Interface ConnectionMonitorInit

                                                                                                                                                                                              interface ConnectionMonitorInit {
                                                                                                                                                                                                  abortConnectionOnPingFailure?: boolean;
                                                                                                                                                                                                  enabled?: boolean;
                                                                                                                                                                                                  pingInterval?: number;
                                                                                                                                                                                                  pingTimeout?: Omit<AdaptiveTimeoutInit, "metrics" | "metricsName">;
                                                                                                                                                                                                  protocolPrefix?: string;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              abortConnectionOnPingFailure? +ConnectionMonitorInit | libp2p

                                                                                                                                                                                              Interface ConnectionMonitorInit

                                                                                                                                                                                              interface ConnectionMonitorInit {
                                                                                                                                                                                                  abortConnectionOnPingFailure?: boolean;
                                                                                                                                                                                                  enabled?: boolean;
                                                                                                                                                                                                  pingInterval?: number;
                                                                                                                                                                                                  pingTimeout?: Omit<AdaptiveTimeoutInit, "metrics" | "metricsName">;
                                                                                                                                                                                                  protocolPrefix?: string;
                                                                                                                                                                                              }

                                                                                                                                                                                              Properties

                                                                                                                                                                                              abortConnectionOnPingFailure? enabled? pingInterval? pingTimeout? @@ -6,17 +6,17 @@

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional abortConnectionOnPingFailure

                                                                                                                                                                                              abortConnectionOnPingFailure?: boolean

                                                                                                                                                                                              If true, any connection that fails the ping will be aborted

                                                                                                                                                                                              Default

                                                                                                                                                                                              true
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional enabled

                                                                                                                                                                                              enabled?: boolean

                                                                                                                                                                                              Whether the connection monitor is enabled

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional enabled

                                                                                                                                                                                              enabled?: boolean

                                                                                                                                                                                              Whether the connection monitor is enabled

                                                                                                                                                                                              Default

                                                                                                                                                                                              true
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional pingInterval

                                                                                                                                                                                              pingInterval?: number

                                                                                                                                                                                              How often to ping remote peers in ms

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional pingInterval

                                                                                                                                                                                              pingInterval?: number

                                                                                                                                                                                              How often to ping remote peers in ms

                                                                                                                                                                                              Default

                                                                                                                                                                                              10000
                                                                                                                                                                                              -

                                                                                                                                                                                              Optional pingTimeout

                                                                                                                                                                                              pingTimeout?: Omit<AdaptiveTimeoutInit, "metrics" | "metricsName">

                                                                                                                                                                                              Timeout settings for how long the ping is allowed to take before the +

                                                                                                                                                                                              Optional pingTimeout

                                                                                                                                                                                              pingTimeout?: Omit<AdaptiveTimeoutInit, "metrics" | "metricsName">

                                                                                                                                                                                              Timeout settings for how long the ping is allowed to take before the connection will be judged inactive and aborted.

                                                                                                                                                                                              The timeout is adaptive to cope with slower networks or nodes that have changing network characteristics, such as mobile.

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional protocolPrefix

                                                                                                                                                                                              protocolPrefix?: string

                                                                                                                                                                                              Override the ping protocol prefix

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional protocolPrefix

                                                                                                                                                                                              protocolPrefix?: string

                                                                                                                                                                                              Override the ping protocol prefix

                                                                                                                                                                                              Default

                                                                                                                                                                                              'ipfs'
                                                                                                                                                                                              -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              abortConnectionOnPingFailureenabledpingIntervalpingTimeoutprotocolPrefix
                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              Theme

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              abortConnectionOnPingFailureenabledpingIntervalpingTimeoutprotocolPrefix
                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/libp2p.index.Libp2pInit.html b/interfaces/libp2p.index.Libp2pInit.html index a61f5ea46b..389fec0156 100644 --- a/interfaces/libp2p.index.Libp2pInit.html +++ b/interfaces/libp2p.index.Libp2pInit.html @@ -1,5 +1,5 @@ Libp2pInit | libp2p

                                                                                                                                                                                              Interface Libp2pInit<T>

                                                                                                                                                                                              For Libp2p configurations and modules details read the Configuration Document.

                                                                                                                                                                                              -
                                                                                                                                                                                              interface Libp2pInit<T> {
                                                                                                                                                                                                  addresses?: AddressManagerInit;
                                                                                                                                                                                                  connectionEncrypters?: ((components) => ConnectionEncrypter<unknown>)[];
                                                                                                                                                                                                  connectionGater?: ConnectionGater;
                                                                                                                                                                                                  connectionManager?: ConnectionManagerInit;
                                                                                                                                                                                                  connectionMonitor?: ConnectionMonitorInit;
                                                                                                                                                                                                  contentRouters?: ((components) => ContentRouting)[];
                                                                                                                                                                                                  datastore?: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                  dns?: DNS;
                                                                                                                                                                                                  logger?: ComponentLogger;
                                                                                                                                                                                                  nodeInfo?: NodeInfo;
                                                                                                                                                                                                  peerDiscovery?: ((components) => PeerDiscovery)[];
                                                                                                                                                                                                  peerRouters?: ((components) => PeerRouting)[];
                                                                                                                                                                                                  peerStore?: PersistentPeerStoreInit;
                                                                                                                                                                                                  privateKey?: PrivateKey;
                                                                                                                                                                                                  services?: ServiceFactoryMap<T>;
                                                                                                                                                                                                  streamMuxers?: ((components) => StreamMuxerFactory)[];
                                                                                                                                                                                                  transportManager?: TransportManagerInit;
                                                                                                                                                                                                  transports?: ((components) => Transport<ProgressEvent<any, unknown>>)[];
                                                                                                                                                                                                  connectionProtector?(components): ConnectionProtector;
                                                                                                                                                                                                  metrics?(components): Metrics;
                                                                                                                                                                                              }

                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                              Properties

                                                                                                                                                                                              addresses? +
                                                                                                                                                                                              interface Libp2pInit<T> {
                                                                                                                                                                                                  addresses?: AddressManagerInit;
                                                                                                                                                                                                  connectionEncrypters?: ((components) => ConnectionEncrypter<unknown>)[];
                                                                                                                                                                                                  connectionGater?: ConnectionGater;
                                                                                                                                                                                                  connectionManager?: ConnectionManagerInit;
                                                                                                                                                                                                  connectionMonitor?: ConnectionMonitorInit;
                                                                                                                                                                                                  contentRouters?: ((components) => ContentRouting)[];
                                                                                                                                                                                                  datastore?: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                  dns?: DNS;
                                                                                                                                                                                                  logger?: ComponentLogger;
                                                                                                                                                                                                  nodeInfo?: NodeInfo;
                                                                                                                                                                                                  peerDiscovery?: ((components) => PeerDiscovery)[];
                                                                                                                                                                                                  peerRouters?: ((components) => PeerRouting)[];
                                                                                                                                                                                                  peerStore?: PersistentPeerStoreInit;
                                                                                                                                                                                                  privateKey?: PrivateKey;
                                                                                                                                                                                                  services?: ServiceFactoryMap<T>;
                                                                                                                                                                                                  streamMuxers?: ((components) => StreamMuxerFactory)[];
                                                                                                                                                                                                  transportManager?: TransportManagerInit;
                                                                                                                                                                                                  transports?: ((components) => Transport<ProgressEvent<any, unknown>>)[];
                                                                                                                                                                                                  connectionProtector?(components): ConnectionProtector;
                                                                                                                                                                                                  metrics?(components): Metrics;
                                                                                                                                                                                              }

                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                              Properties

                                                                                                                                                                                              addresses? connectionEncrypters? connectionGater? connectionManager? @@ -20,19 +20,19 @@

                                                                                                                                                                                              Methods

                                                                                                                                                                                              connectionProtector? metrics?

                                                                                                                                                                                              Properties

                                                                                                                                                                                              Optional addresses

                                                                                                                                                                                              addresses?: AddressManagerInit

                                                                                                                                                                                              Addresses for transport listening and to advertise to the network

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional connectionEncrypters

                                                                                                                                                                                              connectionEncrypters?: ((components) => ConnectionEncrypter<unknown>)[]

                                                                                                                                                                                              Connection encrypters ensure that data sent over connections cannot be +

                                                                                                                                                                                              Optional connectionEncrypters

                                                                                                                                                                                              connectionEncrypters?: ((components) => ConnectionEncrypter<unknown>)[]

                                                                                                                                                                                              Connection encrypters ensure that data sent over connections cannot be eavesdropped on, and that the remote peer posesses the private key that corresponds to the public key that it's Peer ID is derived from.

                                                                                                                                                                                              -

                                                                                                                                                                                              Type declaration

                                                                                                                                                                                              Optional connectionGater

                                                                                                                                                                                              connectionGater?: ConnectionGater

                                                                                                                                                                                              A connection gater can deny new connections based on user criteria

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional connectionManager

                                                                                                                                                                                              connectionManager?: ConnectionManagerInit

                                                                                                                                                                                              libp2p Connection Manager configuration

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional connectionMonitor

                                                                                                                                                                                              connectionMonitor?: ConnectionMonitorInit

                                                                                                                                                                                              libp2p Connection Monitor configuration

                                                                                                                                                                                              -

                                                                                                                                                                                              Optional contentRouters

                                                                                                                                                                                              contentRouters?: ((components) => ContentRouting)[]

                                                                                                                                                                                              Content routers provide implementations for content routing queries

                                                                                                                                                                                              -

                                                                                                                                                                                              Type declaration

                                                                                                                                                                                              Optional datastore

                                                                                                                                                                                              datastore?: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                              An optional datastore to persist peer information, DHT records, etc.

                                                                                                                                                                                              +

                                                                                                                                                                                              Type declaration

                                                                                                                                                                                              Optional connectionGater

                                                                                                                                                                                              connectionGater?: ConnectionGater

                                                                                                                                                                                              A connection gater can deny new connections based on user criteria

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional connectionManager

                                                                                                                                                                                              connectionManager?: ConnectionManagerInit

                                                                                                                                                                                              libp2p Connection Manager configuration

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional connectionMonitor

                                                                                                                                                                                              connectionMonitor?: ConnectionMonitorInit

                                                                                                                                                                                              libp2p Connection Monitor configuration

                                                                                                                                                                                              +

                                                                                                                                                                                              Optional contentRouters

                                                                                                                                                                                              contentRouters?: ((components) => ContentRouting)[]

                                                                                                                                                                                              Content routers provide implementations for content routing queries

                                                                                                                                                                                              +

                                                                                                                                                                                              Type declaration

                                                                                                                                                                                              Optional datastore

                                                                                                                                                                                              datastore?: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                              An optional datastore to persist peer information, DHT records, etc.

                                                                                                                                                                                              An in-memory datastore will be used if one is not provided.

                                                                                                                                                                                              -

                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                  Optional dns

                                                                                                                                                                                                                  dns?: DNS

                                                                                                                                                                                                                  An optional DNS resolver configuration. If omitted the default DNS resolver +

                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                      Optional dns

                                                                                                                                                                                                                                      dns?: DNS

                                                                                                                                                                                                                                      An optional DNS resolver configuration. If omitted the default DNS resolver for the platform will be used which means node:dns on Node.js and DNS-JSON-over-HTTPS for browsers using Google and Cloudflare servers.

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Optional logger

                                                                                                                                                                                                                                      logger?: ComponentLogger

                                                                                                                                                                                                                                      An optional logging implementation that can be used to write runtime logs.

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Optional logger

                                                                                                                                                                                                                                      logger?: ComponentLogger

                                                                                                                                                                                                                                      An optional logging implementation that can be used to write runtime logs.

                                                                                                                                                                                                                                      Set the DEBUG env var or the debug key on LocalStorage to see logs.

                                                                                                                                                                                                                                      Example

                                                                                                                                                                                                                                      Node.js:

                                                                                                                                                                                                                                      $ DEBUG="*libp2p:*" node myscript.js
@@ -40,19 +40,19 @@
 
                                                                                                                                                                                                                                      Browsers:
                                                                                                                                                                                                                                      
 
                                                                                                                                                                                                                                      localStorage.setItem('debug', '*libp2p:*')
 
                                                                                                                                                                                                                                      
-

                                                                                                                                                                                                                                      Optional nodeInfo

                                                                                                                                                                                                                                      nodeInfo?: NodeInfo

                                                                                                                                                                                                                                      Metadata about the node - implementation name, version number, etc

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Optional peerDiscovery

                                                                                                                                                                                                                                      peerDiscovery?: ((components) => PeerDiscovery)[]

                                                                                                                                                                                                                                      Peer discovery mechanisms allow finding peers on the network

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                      Optional peerRouters

                                                                                                                                                                                                                                      peerRouters?: ((components) => PeerRouting)[]

                                                                                                                                                                                                                                      Peer routers provide implementations for peer routing queries

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                      Optional peerStore

                                                                                                                                                                                                                                      peerStore?: PersistentPeerStoreInit

                                                                                                                                                                                                                                      libp2p PeerStore configuration

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Optional privateKey

                                                                                                                                                                                                                                      privateKey?: PrivateKey

                                                                                                                                                                                                                                      The private key is used in cryptographic operations and the Peer ID derived +

                                                                                                                                                                                                                                      Optional nodeInfo

                                                                                                                                                                                                                                      nodeInfo?: NodeInfo

                                                                                                                                                                                                                                      Metadata about the node - implementation name, version number, etc

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Optional peerDiscovery

                                                                                                                                                                                                                                      peerDiscovery?: ((components) => PeerDiscovery)[]

                                                                                                                                                                                                                                      Peer discovery mechanisms allow finding peers on the network

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                      Optional peerRouters

                                                                                                                                                                                                                                      peerRouters?: ((components) => PeerRouting)[]

                                                                                                                                                                                                                                      Peer routers provide implementations for peer routing queries

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                      Optional peerStore

                                                                                                                                                                                                                                      peerStore?: PersistentPeerStoreInit

                                                                                                                                                                                                                                      libp2p PeerStore configuration

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Optional privateKey

                                                                                                                                                                                                                                      privateKey?: PrivateKey

                                                                                                                                                                                                                                      The private key is used in cryptographic operations and the Peer ID derived from it's corresponding public key is used to identify the node to other peers on the network.

                                                                                                                                                                                                                                      If this is not passed a new Ed25519 private key will be generated.

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Optional services

                                                                                                                                                                                                                                      services?: ServiceFactoryMap<T>

                                                                                                                                                                                                                                      Arbitrary libp2p modules

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Optional streamMuxers

                                                                                                                                                                                                                                      streamMuxers?: ((components) => StreamMuxerFactory)[]

                                                                                                                                                                                                                                      Stream muxers allow the creation of many data streams over a single +

                                                                                                                                                                                                                                      Optional services

                                                                                                                                                                                                                                      services?: ServiceFactoryMap<T>

                                                                                                                                                                                                                                      Arbitrary libp2p modules

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Optional streamMuxers

                                                                                                                                                                                                                                      streamMuxers?: ((components) => StreamMuxerFactory)[]

                                                                                                                                                                                                                                      Stream muxers allow the creation of many data streams over a single connection.

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                      Optional transportManager

                                                                                                                                                                                                                                      transportManager?: TransportManagerInit

                                                                                                                                                                                                                                      libp2p transport manager configuration

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Optional transports

                                                                                                                                                                                                                                      transports?: ((components) => Transport<ProgressEvent<any, unknown>>)[]

                                                                                                                                                                                                                                      Transports are low-level communication channels

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                      Optional connectionProtector

                                                                                                                                                                                                                                      Optional metrics

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                      addressesconnectionEncryptersconnectionGaterconnectionManagerconnectionMonitorcontentRoutersdatastorednsloggernodeInfopeerDiscoverypeerRouterspeerStoreprivateKeyservicesstreamMuxerstransportManagertransportsconnectionProtectormetrics
                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                      Optional transportManager

                                                                                                                                                                                                                                      transportManager?: TransportManagerInit

                                                                                                                                                                                                                                      libp2p transport manager configuration

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Optional transports

                                                                                                                                                                                                                                      transports?: ((components) => Transport<ProgressEvent<any, unknown>>)[]

                                                                                                                                                                                                                                      Transports are low-level communication channels

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                      Optional connectionProtector

                                                                                                                                                                                                                                      Optional metrics

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                      addressesconnectionEncryptersconnectionGaterconnectionManagerconnectionMonitorcontentRoutersdatastorednsloggernodeInfopeerDiscoverypeerRouterspeerStoreprivateKeyservicesstreamMuxerstransportManagertransportsconnectionProtectormetrics
                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/interfaces/libp2p.index.TransportManagerInit.html b/interfaces/libp2p.index.TransportManagerInit.html index 4c8a293f3f..e358364672 100644 --- a/interfaces/libp2p.index.TransportManagerInit.html +++ b/interfaces/libp2p.index.TransportManagerInit.html @@ -1,2 +1,2 @@ -TransportManagerInit | libp2p

                                                                                                                                                                                                                                      Interface TransportManagerInit

                                                                                                                                                                                                                                      interface TransportManagerInit {
                                                                                                                                                                                                                                          faultTolerance?: FaultTolerance;
                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      faultTolerance? -

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      Optional faultTolerance

                                                                                                                                                                                                                                      faultTolerance?: FaultTolerance

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                      faultTolerance
                                                                                                                                                                                                                                      \ No newline at end of file +TransportManagerInit | libp2p

                                                                                                                                                                                                                                      Interface TransportManagerInit

                                                                                                                                                                                                                                      interface TransportManagerInit {
                                                                                                                                                                                                                                          faultTolerance?: FaultTolerance;
                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      faultTolerance? +

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      Optional faultTolerance

                                                                                                                                                                                                                                      faultTolerance?: FaultTolerance

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                      faultTolerance
                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_auto_tls.html b/modules/_libp2p_auto_tls.html index ff42acfbd5..f23846f5f7 100644 --- a/modules/_libp2p_auto_tls.html +++ b/modules/_libp2p_auto_tls.html @@ -1,5 +1,5 @@ @libp2p/auto-tls | libp2p

                                                                                                                                                                                                                                      Module @libp2p/auto-tls

                                                                                                                                                                                                                                      When a publicly dialable address is detected, use the p2p-forge service at -https://registration.libp2p.direct to acquire a valid Let's Encrypted-backed +https://registration.libp2p.direct to acquire a valid Let's Encrypt-backed TLS certificate, which the node can then use with the relevant transports.

                                                                                                                                                                                                                                      The node must be configured with a listener for at least one of the following transports:

                                                                                                                                                                                                                                      @@ -34,7 +34,7 @@ -->

                                                                                                                                                                                                                                      When a publicly dialable address is detected, use the p2p-forge service at -https://registration.libp2p.direct to acquire a valid Let's Encrypted-backed +https://registration.libp2p.direct to acquire a valid Let's Encrypt-backed TLS certificate, which the node can then use with the relevant transports.

                                                                                                                                                                                                                                      The node must be configured with a listener for at least one of the following transports:

                                                                                                                                                                                                                                      diff --git a/modules/_libp2p_circuit_relay_v2.Limit.html b/modules/_libp2p_circuit_relay_v2.Limit.html index 20748a8f83..9f2242e93f 100644 --- a/modules/_libp2p_circuit_relay_v2.Limit.html +++ b/modules/_libp2p_circuit_relay_v2.Limit.html @@ -1,4 +1,4 @@ -Limit | libp2p

                                                                                                                                                                                                                                      Namespace Limit

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      codec +Limit | libp2p

                                                                                                                                                                                                                                      Namespace Limit

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      codec decode encode

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_crypto.ciphers.AES_GCM.html b/modules/_libp2p_crypto.ciphers.AES_GCM.html index 2799faaad4..5de50b1a7c 100644 --- a/modules/_libp2p_crypto.ciphers.AES_GCM.html +++ b/modules/_libp2p_crypto.ciphers.AES_GCM.html @@ -1,2 +1,2 @@ -AES_GCM | libp2p

                                                                                                                                                                                                                                      Namespace AES_GCM

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      create +AES_GCM | libp2p

                                                                                                                                                                                                                                      Namespace AES_GCM

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      create

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_crypto.ciphers.html b/modules/_libp2p_crypto.ciphers.html index 7b160cdebd..a3856345a3 100644 --- a/modules/_libp2p_crypto.ciphers.html +++ b/modules/_libp2p_crypto.ciphers.html @@ -1,2 +1,2 @@ -ciphers | libp2p

                                                                                                                                                                                                                                      Module ciphers

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Namespaces

                                                                                                                                                                                                                                      AES_GCM +ciphers | libp2p

                                                                                                                                                                                                                                      Module ciphers

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Namespaces

                                                                                                                                                                                                                                      AES_GCM

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_crypto.hmac.html b/modules/_libp2p_crypto.hmac.html index 140ec870ab..7b8c2dfb99 100644 --- a/modules/_libp2p_crypto.hmac.html +++ b/modules/_libp2p_crypto.hmac.html @@ -1,6 +1,6 @@ hmac | libp2p

                                                                                                                                                                                                                                      Module hmac

                                                                                                                                                                                                                                      Exposes an interface to the Keyed-Hash Message Authentication Code (HMAC) as defined in U.S. Federal Information Processing Standards Publication 198. An HMAC is a cryptographic hash that uses a key to sign a message. The receiver verifies the hash by recomputing it using the same key.

                                                                                                                                                                                                                                      Example

                                                                                                                                                                                                                                      import { create } from '@libp2p/hmac'

                                                                                                                                                                                                                                      const hash = 'SHA1' // 'SHA256' || 'SHA512'
                                                                                                                                                                                                                                      const hmac = await crypto.hmac.create(hash, uint8ArrayFromString('secret'))
                                                                                                                                                                                                                                      const sig = await hmac.digest(uint8ArrayFromString('hello world'))
                                                                                                                                                                                                                                      console.log(sig)
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      HMAC +

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      HMAC

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      create

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_crypto.index.html b/modules/_libp2p_crypto.index.html index 9ca4b0233f..ad79d7e684 100644 --- a/modules/_libp2p_crypto.index.html +++ b/modules/_libp2p_crypto.index.html @@ -1,7 +1,7 @@ index | libp2p

                                                                                                                                                                                                                                      Module index

                                                                                                                                                                                                                                      The libp2p-crypto library depends on the Web Crypto API in the browser. Web Crypto is available in all modern browsers, however browsers restrict its usage to Secure Contexts.

                                                                                                                                                                                                                                      This means you will not be able to use some @libp2p/crypto functions in the browser when the page is served over HTTP.

                                                                                                                                                                                                                                      To enable the Web Crypto API and allow @libp2p/crypto to work fully, please serve your page over HTTPS.

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      References

                                                                                                                                                                                                                                      hmac +

                                                                                                                                                                                                                                      References

                                                                                                                                                                                                                                      hmac keys

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      pbkdf2 randomBytes diff --git a/modules/_libp2p_crypto.keys.html b/modules/_libp2p_crypto.keys.html index a0f01a0bef..6d4dcf2f51 100644 --- a/modules/_libp2p_crypto.keys.html +++ b/modules/_libp2p_crypto.keys.html @@ -1,6 +1,6 @@ keys | libp2p

                                                                                                                                                                                                                                      Module keys

                                                                                                                                                                                                                                      Supported Key Types

                                                                                                                                                                                                                                      Currently the 'RSA', 'ed25519', and secp256k1 types are supported, although ed25519 and secp256k1 keys support only signing and verification of messages.

                                                                                                                                                                                                                                      For encryption / decryption support, RSA keys should be used.

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      ECDHKey +

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      ECDHKey ECDHKeyPair EnhancedKey EnhancedKeyPair diff --git a/modules/_libp2p_crypto.webcrypto.html b/modules/_libp2p_crypto.webcrypto.html index c926195d31..136a7012e1 100644 --- a/modules/_libp2p_crypto.webcrypto.html +++ b/modules/_libp2p_crypto.webcrypto.html @@ -1,2 +1,2 @@ -webcrypto | libp2p

                                                                                                                                                                                                                                      Module webcrypto

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Variables

                                                                                                                                                                                                                                      default +webcrypto | libp2p

                                                                                                                                                                                                                                      Module webcrypto

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Variables

                                                                                                                                                                                                                                      default

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_devtools_metrics.index.html b/modules/_libp2p_devtools_metrics.index.html index e656190867..17ced51271 100644 --- a/modules/_libp2p_devtools_metrics.index.html +++ b/modules/_libp2p_devtools_metrics.index.html @@ -3,7 +3,7 @@

                                                                                                                                                                                                                                      Then use the DevTools plugin for Chrome or Firefox to inspect the state of your running node.

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      References

                                                                                                                                                                                                                                      DevToolsEvents +

                                                                                                                                                                                                                                      References

                                                                                                                                                                                                                                      DevToolsEvents DevToolsRPC MetricsRPC Peer diff --git a/modules/_libp2p_devtools_metrics.rpc.html b/modules/_libp2p_devtools_metrics.rpc.html index 7a0eb49ae2..abb4daea7a 100644 --- a/modules/_libp2p_devtools_metrics.rpc.html +++ b/modules/_libp2p_devtools_metrics.rpc.html @@ -1,4 +1,4 @@ -rpc | libp2p

                                                                                                                                                                                                                                      Module rpc

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      DevToolsEvents +rpc | libp2p

                                                                                                                                                                                                                                      Module rpc

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      DevToolsEvents DevToolsRPC MetricsRPC Peer diff --git a/modules/_libp2p_interface_compliance_tests.connection_encryption.html b/modules/_libp2p_interface_compliance_tests.connection_encryption.html index c25f5895b4..b9af041b6d 100644 --- a/modules/_libp2p_interface_compliance_tests.connection_encryption.html +++ b/modules/_libp2p_interface_compliance_tests.connection_encryption.html @@ -1,3 +1,3 @@ -connection-encryption | libp2p

                                                                                                                                                                                                                                      Module connection-encryption

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      ConnectionEncrypterSetupArgs +connection-encryption | libp2p

                                                                                                                                                                                                                                      Module connection-encryption

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      ConnectionEncrypterSetupArgs

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      default

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_interface_compliance_tests.index.html b/modules/_libp2p_interface_compliance_tests.index.html index e3d4eb0508..31ee1da6ea 100644 --- a/modules/_libp2p_interface_compliance_tests.index.html +++ b/modules/_libp2p_interface_compliance_tests.index.html @@ -1,2 +1,2 @@ -index | libp2p

                                                                                                                                                                                                                                      Module index

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      TestSetup +index | libp2p

                                                                                                                                                                                                                                      Module index

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      TestSetup

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_interface_compliance_tests.is_valid_tick.html b/modules/_libp2p_interface_compliance_tests.is_valid_tick.html index c8cebcdf67..0efa88efff 100644 --- a/modules/_libp2p_interface_compliance_tests.is_valid_tick.html +++ b/modules/_libp2p_interface_compliance_tests.is_valid_tick.html @@ -1,2 +1,2 @@ -is-valid-tick | libp2p

                                                                                                                                                                                                                                      Module is-valid-tick

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      isValidTick +is-valid-tick | libp2p

                                                                                                                                                                                                                                      Module is-valid-tick

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      isValidTick

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_interface_compliance_tests.matchers.html b/modules/_libp2p_interface_compliance_tests.matchers.html index ab81d868ca..3beda6ba00 100644 --- a/modules/_libp2p_interface_compliance_tests.matchers.html +++ b/modules/_libp2p_interface_compliance_tests.matchers.html @@ -1,3 +1,3 @@ -matchers | libp2p

                                                                                                                                                                                                                                      Module matchers

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      matchMultiaddr +matchers | libp2p

                                                                                                                                                                                                                                      Module matchers

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      matchMultiaddr matchPeerId

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_interface_compliance_tests.mocks.html b/modules/_libp2p_interface_compliance_tests.mocks.html index 6827f1365b..e9f08d251c 100644 --- a/modules/_libp2p_interface_compliance_tests.mocks.html +++ b/modules/_libp2p_interface_compliance_tests.mocks.html @@ -1,4 +1,4 @@ -mocks | libp2p

                                                                                                                                                                                                                                      Module mocks

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      MockNetwork +mocks | libp2p

                                                                                                                                                                                                                                      Module mocks

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      MockNetwork

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      MockConnectionManagerComponents MockConnectionOptions MockMultiaddrConnPairOptions diff --git a/modules/_libp2p_interface_compliance_tests.peer_discovery.html b/modules/_libp2p_interface_compliance_tests.peer_discovery.html index 014c0769ad..9eb5130a9d 100644 --- a/modules/_libp2p_interface_compliance_tests.peer_discovery.html +++ b/modules/_libp2p_interface_compliance_tests.peer_discovery.html @@ -1,2 +1,2 @@ -peer-discovery | libp2p

                                                                                                                                                                                                                                      Module peer-discovery

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      default +peer-discovery | libp2p

                                                                                                                                                                                                                                      Module peer-discovery

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      default

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_interface_compliance_tests.pubsub.html b/modules/_libp2p_interface_compliance_tests.pubsub.html index 0d9bb15116..90173543f3 100644 --- a/modules/_libp2p_interface_compliance_tests.pubsub.html +++ b/modules/_libp2p_interface_compliance_tests.pubsub.html @@ -1,4 +1,4 @@ -pubsub | libp2p

                                                                                                                                                                                                                                      Module pubsub

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      PubSubArgs +pubsub | libp2p

                                                                                                                                                                                                                                      Module pubsub

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      PubSubArgs PubSubComponents

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      default

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_interface_compliance_tests.stream_muxer.html b/modules/_libp2p_interface_compliance_tests.stream_muxer.html index 698a6fa473..6a12efba33 100644 --- a/modules/_libp2p_interface_compliance_tests.stream_muxer.html +++ b/modules/_libp2p_interface_compliance_tests.stream_muxer.html @@ -1,2 +1,2 @@ -stream-muxer | libp2p

                                                                                                                                                                                                                                      Module stream-muxer

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      default +stream-muxer | libp2p

                                                                                                                                                                                                                                      Module stream-muxer

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      default

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_interface_compliance_tests.transport.html b/modules/_libp2p_interface_compliance_tests.transport.html index 0134e35538..da86c9b30f 100644 --- a/modules/_libp2p_interface_compliance_tests.transport.html +++ b/modules/_libp2p_interface_compliance_tests.transport.html @@ -1,3 +1,3 @@ -transport | libp2p

                                                                                                                                                                                                                                      Module transport

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      TransportTestFixtures +transport | libp2p

                                                                                                                                                                                                                                      Module transport

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      TransportTestFixtures

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      default

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_kad_dht.MessageType.html b/modules/_libp2p_kad_dht.MessageType.html index 6011609111..29bf909e27 100644 --- a/modules/_libp2p_kad_dht.MessageType.html +++ b/modules/_libp2p_kad_dht.MessageType.html @@ -1,3 +1,3 @@ MessageType | libp2p

                                                                                                                                                                                                                                      Namespace MessageType

                                                                                                                                                                                                                                      The types of messages sent to peers during DHT queries

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      codec +

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      codec

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_pubsub.index.html b/modules/_libp2p_pubsub.index.html index 37ec898b64..905ead3de5 100644 --- a/modules/_libp2p_pubsub.index.html +++ b/modules/_libp2p_pubsub.index.html @@ -1,6 +1,6 @@ index | libp2p

                                                                                                                                                                                                                                      Module index

                                                                                                                                                                                                                                      A set of components to be extended in order to create a pubsub implementation.

                                                                                                                                                                                                                                      Example

                                                                                                                                                                                                                                      import { PubSubBaseProtocol } from '@libp2p/pubsub'
                                                                                                                                                                                                                                      import type { PubSubRPC, PublishResult, PubSubRPCMessage, PeerId, Message } from '@libp2p/interface'
                                                                                                                                                                                                                                      import type { Uint8ArrayList } from 'uint8arraylist'

                                                                                                                                                                                                                                      class MyPubsubImplementation extends PubSubBaseProtocol {
                                                                                                                                                                                                                                        decodeRpc (bytes: Uint8Array | Uint8ArrayList): PubSubRPC {
                                                                                                                                                                                                                                          throw new Error('Not implemented')
                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                        encodeRpc (rpc: PubSubRPC): Uint8Array {
                                                                                                                                                                                                                                          throw new Error('Not implemented')
                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                        encodeMessage (rpc: PubSubRPCMessage): Uint8Array {
                                                                                                                                                                                                                                          throw new Error('Not implemented')
                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                        async publishMessage (sender: PeerId, message: Message): Promise<PublishResult> {
                                                                                                                                                                                                                                          throw new Error('Not implemented')
                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      PubSubBaseProtocol +

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      PubSubBaseProtocol

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      PubSubComponents

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_pubsub.peer_streams.html b/modules/_libp2p_pubsub.peer_streams.html index 609065e154..694cccd946 100644 --- a/modules/_libp2p_pubsub.peer_streams.html +++ b/modules/_libp2p_pubsub.peer_streams.html @@ -1,4 +1,4 @@ -peer-streams | libp2p

                                                                                                                                                                                                                                      Module peer-streams

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      PeerStreams +peer-streams | libp2p

                                                                                                                                                                                                                                      Module peer-streams

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      PeerStreams

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      PeerStreamsComponents PeerStreamsInit

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_pubsub.utils.html b/modules/_libp2p_pubsub.utils.html index 5185562c0f..02159afb76 100644 --- a/modules/_libp2p_pubsub.utils.html +++ b/modules/_libp2p_pubsub.utils.html @@ -1,4 +1,4 @@ -utils | libp2p

                                                                                                                                                                                                                                      Module utils

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      anyMatch +utils | libp2p

                                                                                                                                                                                                                                      Module utils

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      anyMatch bigIntFromBytes bigIntToBytes ensureArray diff --git a/modules/_libp2p_utils.abort_options.html b/modules/_libp2p_utils.abort_options.html index 015e219475..474d87b6f1 100644 --- a/modules/_libp2p_utils.abort_options.html +++ b/modules/_libp2p_utils.abort_options.html @@ -1,2 +1,2 @@ -abort-options | libp2p

                                                                                                                                                                                                                                      Module abort-options

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      createTimeoutOptions +abort-options | libp2p

                                                                                                                                                                                                                                      Module abort-options

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      createTimeoutOptions

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.abstract_stream.html b/modules/_libp2p_utils.abstract_stream.html index 335e62d327..8e5d37d265 100644 --- a/modules/_libp2p_utils.abstract_stream.html +++ b/modules/_libp2p_utils.abstract_stream.html @@ -1,3 +1,3 @@ -abstract-stream | libp2p

                                                                                                                                                                                                                                      Module abstract-stream

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      AbstractStream +abstract-stream | libp2p

                                                                                                                                                                                                                                      Module abstract-stream

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      AbstractStream

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      AbstractStreamInit

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.adaptive_timeout.html b/modules/_libp2p_utils.adaptive_timeout.html index 75fe26d5de..c9707d8e68 100644 --- a/modules/_libp2p_utils.adaptive_timeout.html +++ b/modules/_libp2p_utils.adaptive_timeout.html @@ -1,4 +1,4 @@ -adaptive-timeout | libp2p

                                                                                                                                                                                                                                      Module adaptive-timeout

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      AdaptiveTimeout +adaptive-timeout | libp2p

                                                                                                                                                                                                                                      Module adaptive-timeout

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      AdaptiveTimeout

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      AdaptiveTimeoutInit AdaptiveTimeoutSignal GetTimeoutSignalOptions diff --git a/modules/_libp2p_utils.array_equals.html b/modules/_libp2p_utils.array_equals.html index 91419f362b..1cf44ff19f 100644 --- a/modules/_libp2p_utils.array_equals.html +++ b/modules/_libp2p_utils.array_equals.html @@ -1,5 +1,5 @@ array-equals | libp2p

                                                                                                                                                                                                                                      Module array-equals

                                                                                                                                                                                                                                      Provides strategies ensure arrays are equivalent.

                                                                                                                                                                                                                                      Example

                                                                                                                                                                                                                                      import { arrayEquals } from '@libp2p/utils/array-equals'
                                                                                                                                                                                                                                      import { multiaddr } from '@multformats/multiaddr'

                                                                                                                                                                                                                                      const ma1 = multiaddr('/ip4/127.0.0.1/tcp/9000'),
                                                                                                                                                                                                                                      const ma2 = multiaddr('/ip4/82.41.53.1/tcp/9000')

                                                                                                                                                                                                                                      console.info(arrayEquals([ma1], [ma1])) // true
                                                                                                                                                                                                                                      console.info(arrayEquals([ma1], [ma2])) // false
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      arrayEquals +

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      arrayEquals

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.close.html b/modules/_libp2p_utils.close.html index 844105871c..30beec4021 100644 --- a/modules/_libp2p_utils.close.html +++ b/modules/_libp2p_utils.close.html @@ -1,4 +1,4 @@ -close | libp2p

                                                                                                                                                                                                                                      Module close

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      SafelyCloseConnectionOptions +close | libp2p

                                                                                                                                                                                                                                      Module close

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      SafelyCloseConnectionOptions

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      safelyCloseConnectionIfUnused safelyCloseStream

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.close_source.html b/modules/_libp2p_utils.close_source.html index d4f78939bf..af422ccdf0 100644 --- a/modules/_libp2p_utils.close_source.html +++ b/modules/_libp2p_utils.close_source.html @@ -1,2 +1,2 @@ -close-source | libp2p

                                                                                                                                                                                                                                      Module close-source

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      closeSource +close-source | libp2p

                                                                                                                                                                                                                                      Module close-source

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      closeSource

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.debounce.html b/modules/_libp2p_utils.debounce.html index 2b7109435a..1792793e57 100644 --- a/modules/_libp2p_utils.debounce.html +++ b/modules/_libp2p_utils.debounce.html @@ -1,3 +1,3 @@ -debounce | libp2p

                                                                                                                                                                                                                                      Module debounce

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      DebouncedFunction +debounce | libp2p

                                                                                                                                                                                                                                      Module debounce

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      DebouncedFunction

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      debounce

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.filters.html b/modules/_libp2p_utils.filters.html index 2fdcb0be0f..0e91a93bed 100644 --- a/modules/_libp2p_utils.filters.html +++ b/modules/_libp2p_utils.filters.html @@ -1,4 +1,4 @@ -filters | libp2p

                                                                                                                                                                                                                                      Module filters

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      BloomFilter +filters | libp2p

                                                                                                                                                                                                                                      Module filters

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      BloomFilter Bucket CuckooFilter Fingerprint diff --git a/modules/_libp2p_utils.global_unicast_ip.html b/modules/_libp2p_utils.global_unicast_ip.html index 41041129e5..060e53f22b 100644 --- a/modules/_libp2p_utils.global_unicast_ip.html +++ b/modules/_libp2p_utils.global_unicast_ip.html @@ -1,2 +1,2 @@ -global-unicast-ip | libp2p

                                                                                                                                                                                                                                      Module global-unicast-ip

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      isGlobalUnicastIp +global-unicast-ip | libp2p

                                                                                                                                                                                                                                      Module global-unicast-ip

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      isGlobalUnicastIp

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.index.html b/modules/_libp2p_utils.index.html index 6f87bb24a8..ac84e4f2b2 100644 --- a/modules/_libp2p_utils.index.html +++ b/modules/_libp2p_utils.index.html @@ -7,4 +7,4 @@

                                                                                                                                                                                                                                      Example

                                                                                                                                                                                                                                      Each function should be imported directly.

                                                                                                                                                                                                                                      import { ipPortToMultiaddr } from '@libp2p/utils/ip-port-to-multiaddr'

                                                                                                                                                                                                                                      const ma = ipPortToMultiaddr('127.0.0.1', 9000)
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.ip_port_to_multiaddr.html b/modules/_libp2p_utils.ip_port_to_multiaddr.html index 40c13d188b..a9b4f63192 100644 --- a/modules/_libp2p_utils.ip_port_to_multiaddr.html +++ b/modules/_libp2p_utils.ip_port_to_multiaddr.html @@ -1,2 +1,2 @@ -ip-port-to-multiaddr | libp2p

                                                                                                                                                                                                                                      Module ip-port-to-multiaddr

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      ipPortToMultiaddr +ip-port-to-multiaddr | libp2p

                                                                                                                                                                                                                                      Module ip-port-to-multiaddr

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      ipPortToMultiaddr

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.is_promise.html b/modules/_libp2p_utils.is_promise.html index fb827f2d6b..f7e86cea6e 100644 --- a/modules/_libp2p_utils.is_promise.html +++ b/modules/_libp2p_utils.is_promise.html @@ -1,2 +1,2 @@ -is-promise | libp2p

                                                                                                                                                                                                                                      Module is-promise

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      isPromise +is-promise | libp2p

                                                                                                                                                                                                                                      Module is-promise

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      isPromise

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.link_local_ip.html b/modules/_libp2p_utils.link_local_ip.html index 3cdcd927f3..93164345e8 100644 --- a/modules/_libp2p_utils.link_local_ip.html +++ b/modules/_libp2p_utils.link_local_ip.html @@ -1,2 +1,2 @@ -link-local-ip | libp2p

                                                                                                                                                                                                                                      Module link-local-ip

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      isLinkLocalIp +link-local-ip | libp2p

                                                                                                                                                                                                                                      Module link-local-ip

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      isLinkLocalIp

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.moving_average.html b/modules/_libp2p_utils.moving_average.html index 491ec4e244..2d02d46bbf 100644 --- a/modules/_libp2p_utils.moving_average.html +++ b/modules/_libp2p_utils.moving_average.html @@ -1,2 +1,2 @@ -moving-average | libp2p

                                                                                                                                                                                                                                      Module moving-average

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      MovingAverage +moving-average | libp2p

                                                                                                                                                                                                                                      Module moving-average

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      MovingAverage

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.multiaddr_is_global_unicast.html b/modules/_libp2p_utils.multiaddr_is_global_unicast.html index da8cfb9458..f6d289e465 100644 --- a/modules/_libp2p_utils.multiaddr_is_global_unicast.html +++ b/modules/_libp2p_utils.multiaddr_is_global_unicast.html @@ -1,2 +1,2 @@ -multiaddr/is-global-unicast | libp2p

                                                                                                                                                                                                                                      Module multiaddr/is-global-unicast

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      isGlobalUnicast +multiaddr/is-global-unicast | libp2p

                                                                                                                                                                                                                                      Module multiaddr/is-global-unicast

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      isGlobalUnicast

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.multiaddr_is_link_local.html b/modules/_libp2p_utils.multiaddr_is_link_local.html index fdad7c4345..823d57567d 100644 --- a/modules/_libp2p_utils.multiaddr_is_link_local.html +++ b/modules/_libp2p_utils.multiaddr_is_link_local.html @@ -1,2 +1,2 @@ -multiaddr/is-link-local | libp2p

                                                                                                                                                                                                                                      Module multiaddr/is-link-local

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      isLinkLocal +multiaddr/is-link-local | libp2p

                                                                                                                                                                                                                                      Module multiaddr/is-link-local

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      isLinkLocal

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.multiaddr_is_loopback.html b/modules/_libp2p_utils.multiaddr_is_loopback.html index 243a23c194..79b9559b70 100644 --- a/modules/_libp2p_utils.multiaddr_is_loopback.html +++ b/modules/_libp2p_utils.multiaddr_is_loopback.html @@ -1,2 +1,2 @@ -multiaddr/is-loopback | libp2p

                                                                                                                                                                                                                                      Module multiaddr/is-loopback

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      isLoopback +multiaddr/is-loopback | libp2p

                                                                                                                                                                                                                                      Module multiaddr/is-loopback

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      isLoopback

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.multiaddr_is_private.html b/modules/_libp2p_utils.multiaddr_is_private.html index 70669c3c63..5c8e87d736 100644 --- a/modules/_libp2p_utils.multiaddr_is_private.html +++ b/modules/_libp2p_utils.multiaddr_is_private.html @@ -1,2 +1,2 @@ -multiaddr/is-private | libp2p

                                                                                                                                                                                                                                      Module multiaddr/is-private

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      isPrivate +multiaddr/is-private | libp2p

                                                                                                                                                                                                                                      Module multiaddr/is-private

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      isPrivate

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.peer_queue.html b/modules/_libp2p_utils.peer_queue.html index f0cce8d9de..209b2ac390 100644 --- a/modules/_libp2p_utils.peer_queue.html +++ b/modules/_libp2p_utils.peer_queue.html @@ -1,3 +1,3 @@ -peer-queue | libp2p

                                                                                                                                                                                                                                      Module peer-queue

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      PeerQueue +peer-queue | libp2p

                                                                                                                                                                                                                                      Module peer-queue

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      PeerQueue

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      PeerQueueJobOptions

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.priority_queue.html b/modules/_libp2p_utils.priority_queue.html index 7591525905..16c3a46647 100644 --- a/modules/_libp2p_utils.priority_queue.html +++ b/modules/_libp2p_utils.priority_queue.html @@ -1,3 +1,3 @@ -priority-queue | libp2p

                                                                                                                                                                                                                                      Module priority-queue

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      PriorityQueue +priority-queue | libp2p

                                                                                                                                                                                                                                      Module priority-queue

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      PriorityQueue

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      PriorityQueueJobOptions

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.private_ip.html b/modules/_libp2p_utils.private_ip.html index d6df95edb3..b8e23e8803 100644 --- a/modules/_libp2p_utils.private_ip.html +++ b/modules/_libp2p_utils.private_ip.html @@ -1,2 +1,2 @@ -private-ip | libp2p

                                                                                                                                                                                                                                      Module private-ip

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      isPrivateIp +private-ip | libp2p

                                                                                                                                                                                                                                      Module private-ip

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      isPrivateIp

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.queue.html b/modules/_libp2p_utils.queue.html index 7e552dec6a..ed2c768c82 100644 --- a/modules/_libp2p_utils.queue.html +++ b/modules/_libp2p_utils.queue.html @@ -1,4 +1,4 @@ -queue | libp2p

                                                                                                                                                                                                                                      Module queue

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      Job +queue | libp2p

                                                                                                                                                                                                                                      Module queue

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      Job JobRecipient Queue

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      Comparator diff --git a/modules/_libp2p_utils.rate_limiter.html b/modules/_libp2p_utils.rate_limiter.html index a9985b49d5..6b7191835e 100644 --- a/modules/_libp2p_utils.rate_limiter.html +++ b/modules/_libp2p_utils.rate_limiter.html @@ -1,4 +1,4 @@ -rate-limiter | libp2p

                                                                                                                                                                                                                                      Module rate-limiter

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      MemoryStorage +rate-limiter | libp2p

                                                                                                                                                                                                                                      Module rate-limiter

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                      MemoryStorage RateLimiter

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      GetKeySecDurationOptions RateLimiterInit diff --git a/modules/_libp2p_utils.repeating_task.html b/modules/_libp2p_utils.repeating_task.html index 44a7ca7a9c..ee4d9dd3b1 100644 --- a/modules/_libp2p_utils.repeating_task.html +++ b/modules/_libp2p_utils.repeating_task.html @@ -1,4 +1,4 @@ -repeating-task | libp2p

                                                                                                                                                                                                                                      Module repeating-task

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      RepeatingTask +repeating-task | libp2p

                                                                                                                                                                                                                                      Module repeating-task

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      RepeatingTask RepeatingTaskOptions

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      repeatingTask

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.stream_to_ma_conn.html b/modules/_libp2p_utils.stream_to_ma_conn.html index 4999b004c1..f452d9d3bd 100644 --- a/modules/_libp2p_utils.stream_to_ma_conn.html +++ b/modules/_libp2p_utils.stream_to_ma_conn.html @@ -1,3 +1,3 @@ -stream-to-ma-conn | libp2p

                                                                                                                                                                                                                                      Module stream-to-ma-conn

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      StreamProperties +stream-to-ma-conn | libp2p

                                                                                                                                                                                                                                      Module stream-to-ma-conn

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      StreamProperties

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      streamToMaConnection

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.tracked_list.html b/modules/_libp2p_utils.tracked_list.html index 2433d1ba91..75a3f65896 100644 --- a/modules/_libp2p_utils.tracked_list.html +++ b/modules/_libp2p_utils.tracked_list.html @@ -1,3 +1,3 @@ -tracked-list | libp2p

                                                                                                                                                                                                                                      Module tracked-list

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      CreateTrackedListInit +tracked-list | libp2p

                                                                                                                                                                                                                                      Module tracked-list

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      CreateTrackedListInit

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      trackedList

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_utils.tracked_map.html b/modules/_libp2p_utils.tracked_map.html index 17abb8d1af..29d1e7edf5 100644 --- a/modules/_libp2p_utils.tracked_map.html +++ b/modules/_libp2p_utils.tracked_map.html @@ -1,4 +1,4 @@ -tracked-map | libp2p

                                                                                                                                                                                                                                      Module tracked-map

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      CreateTrackedMapInit +tracked-map | libp2p

                                                                                                                                                                                                                                      Module tracked-map

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      CreateTrackedMapInit TrackedMapInit

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      trackedMap

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/modules/_libp2p_websockets.filters.html b/modules/_libp2p_websockets.filters.html index 0623943634..ab1ca8ea58 100644 --- a/modules/_libp2p_websockets.filters.html +++ b/modules/_libp2p_websockets.filters.html @@ -1,4 +1,4 @@ -filters | libp2p

                                                                                                                                                                                                                                      Module filters

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      all +filters | libp2p

                                                                                                                                                                                                                                      Module filters

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      all dnsWsOrWss dnsWss wss diff --git a/modules/_libp2p_websockets.index.html b/modules/_libp2p_websockets.index.html index 1c7b94af3d..2284926cec 100644 --- a/modules/_libp2p_websockets.index.html +++ b/modules/_libp2p_websockets.index.html @@ -1,7 +1,7 @@ index | libp2p

                                                                                                                                                                                                                                      Module index

                                                                                                                                                                                                                                      A libp2p transport based on WebSockets.

                                                                                                                                                                                                                                      Example

                                                                                                                                                                                                                                      import { createLibp2p } from 'libp2p'
                                                                                                                                                                                                                                      import { webSockets } from '@libp2p/websockets'
                                                                                                                                                                                                                                      import { multiaddr } from '@multiformats/multiaddr'

                                                                                                                                                                                                                                      const node = await createLibp2p({
                                                                                                                                                                                                                                        transports: [
                                                                                                                                                                                                                                          webSockets()
                                                                                                                                                                                                                                        ]
                                                                                                                                                                                                                                      //... other config
                                                                                                                                                                                                                                      })
                                                                                                                                                                                                                                      await node.start()

                                                                                                                                                                                                                                      const ma = multiaddr('/dns4/example.com/tcp/9090/tls/ws')
                                                                                                                                                                                                                                      await node.dial(ma)
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      WebSocketsComponents +

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      WebSocketsComponents WebSocketsInit WebSocketsMetrics

                                                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                                                      WebSocketsDialEvents diff --git a/modules/libp2p.index.html b/modules/libp2p.index.html index 62c2f96b7b..ee4bd31a26 100644 --- a/modules/libp2p.index.html +++ b/modules/libp2p.index.html @@ -1,7 +1,7 @@ index | libp2p

                                                                                                                                                                                                                                      Module index

                                                                                                                                                                                                                                      Use the createLibp2p function to create a libp2p node.

                                                                                                                                                                                                                                      Example

                                                                                                                                                                                                                                      import { createLibp2p } from 'libp2p'

                                                                                                                                                                                                                                      const node = await createLibp2p({
                                                                                                                                                                                                                                        // ...other options
                                                                                                                                                                                                                                      })
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      AddressFilter +

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                      AddressFilter AddressManagerInit ConnectionManagerInit ConnectionMonitorInit diff --git a/modules/libp2p.version.html b/modules/libp2p.version.html index 964c132eed..5aba12abc3 100644 --- a/modules/libp2p.version.html +++ b/modules/libp2p.version.html @@ -1,3 +1,3 @@ -version | libp2p

                                                                                                                                                                                                                                      Module version

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Variables

                                                                                                                                                                                                                                      name +version | libp2p

                                                                                                                                                                                                                                      Module version

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Variables

                                                                                                                                                                                                                                      name version

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_crypto.keys.Curve.html b/types/_libp2p_crypto.keys.Curve.html index 952d731a7a..9ce510845f 100644 --- a/types/_libp2p_crypto.keys.Curve.html +++ b/types/_libp2p_crypto.keys.Curve.html @@ -1 +1 @@ -Curve | libp2p

                                                                                                                                                                                                                                      Type alias Curve

                                                                                                                                                                                                                                      Curve: "P-256" | "P-384" | "P-521"

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +Curve | libp2p

                                                                                                                                                                                                                                      Type alias Curve

                                                                                                                                                                                                                                      Curve: "P-256" | "P-384" | "P-521"

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_devtools_metrics.index.ApplicationMessage.html b/types/_libp2p_devtools_metrics.index.ApplicationMessage.html index b7ea093d9e..aa05f33bc4 100644 --- a/types/_libp2p_devtools_metrics.index.ApplicationMessage.html +++ b/types/_libp2p_devtools_metrics.index.ApplicationMessage.html @@ -1,2 +1,2 @@ ApplicationMessage | libp2p

                                                                                                                                                                                                                                      Type alias ApplicationMessage

                                                                                                                                                                                                                                      ApplicationMessage: RPCMessage

                                                                                                                                                                                                                                      Messages that are sent from the application page to the DevTools panel

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_devtools_metrics.index.DevToolsMessage.html b/types/_libp2p_devtools_metrics.index.DevToolsMessage.html index ca1b8a9bdb..1c190b8ba1 100644 --- a/types/_libp2p_devtools_metrics.index.DevToolsMessage.html +++ b/types/_libp2p_devtools_metrics.index.DevToolsMessage.html @@ -1,2 +1,2 @@ DevToolsMessage | libp2p

                                                                                                                                                                                                                                      Type alias DevToolsMessage

                                                                                                                                                                                                                                      DevToolsMessage: CopyToClipboardMessage | RPCMessage

                                                                                                                                                                                                                                      Messages that are sent from the DevTools panel page to the application page

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_devtools_metrics.index.WorkerMessage.html b/types/_libp2p_devtools_metrics.index.WorkerMessage.html index 612164b6f5..7d48443480 100644 --- a/types/_libp2p_devtools_metrics.index.WorkerMessage.html +++ b/types/_libp2p_devtools_metrics.index.WorkerMessage.html @@ -1,2 +1,2 @@ WorkerMessage | libp2p

                                                                                                                                                                                                                                      Type alias WorkerMessage

                                                                                                                                                                                                                                      WorkerMessage: PageLoadedMessage | PermissionsErrorMessage

                                                                                                                                                                                                                                      Messages that are sent from the service worker

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.CalculateMetric.html b/types/_libp2p_interface.CalculateMetric.html index 1e50da6c91..44d39664c0 100644 --- a/types/_libp2p_interface.CalculateMetric.html +++ b/types/_libp2p_interface.CalculateMetric.html @@ -1,3 +1,3 @@ CalculateMetric | libp2p

                                                                                                                                                                                                                                      Type alias CalculateMetric<T>

                                                                                                                                                                                                                                      CalculateMetric<T>: (() => T) | (() => Promise<T>)

                                                                                                                                                                                                                                      A function that returns a tracked metric which may be expensive to calculate so it is only invoked when metrics are being scraped

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                      • T = number

                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                        • (): T

                                                                                                                                                                                                                                        • Returns T

                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                      • T = number

                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                        • (): T

                                                                                                                                                                                                                                        • Returns T

                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.ConnectionStatus.html b/types/_libp2p_interface.ConnectionStatus.html index 187f8de1f9..dd78b49757 100644 --- a/types/_libp2p_interface.ConnectionStatus.html +++ b/types/_libp2p_interface.ConnectionStatus.html @@ -1 +1 @@ -ConnectionStatus | libp2p

                                                                                                                                                                                                                                      Type alias ConnectionStatus

                                                                                                                                                                                                                                      ConnectionStatus: "open" | "closing" | "closed"

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +ConnectionStatus | libp2p

                                                                                                                                                                                                                                      Type alias ConnectionStatus

                                                                                                                                                                                                                                      ConnectionStatus: "open" | "closing" | "closed"

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.Direction.html b/types/_libp2p_interface.Direction.html index 5647a22c6c..571f792d73 100644 --- a/types/_libp2p_interface.Direction.html +++ b/types/_libp2p_interface.Direction.html @@ -1,2 +1,2 @@ Direction | libp2p

                                                                                                                                                                                                                                      Type alias Direction

                                                                                                                                                                                                                                      Direction: "inbound" | "outbound"

                                                                                                                                                                                                                                      Outbound connections are opened by the local node, inbound streams are opened by the remote

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.EventHandler.html b/types/_libp2p_interface.EventHandler.html index e8fd9a5bdc..5f4bf0074d 100644 --- a/types/_libp2p_interface.EventHandler.html +++ b/types/_libp2p_interface.EventHandler.html @@ -1 +1 @@ -EventHandler | libp2p

                                                                                                                                                                                                                                      Type alias EventHandler<EventType>

                                                                                                                                                                                                                                      EventHandler<EventType>: EventCallback<EventType> | EventObject<EventType>

                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                      • EventType

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +EventHandler | libp2p

                                                                                                                                                                                                                                      Type alias EventHandler<EventType>

                                                                                                                                                                                                                                      EventHandler<EventType>: EventCallback<EventType> | EventObject<EventType>

                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                      • EventType

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.InboundConnectionUpgradeEvents.html b/types/_libp2p_interface.InboundConnectionUpgradeEvents.html index b5e3ba5f67..c4a430b629 100644 --- a/types/_libp2p_interface.InboundConnectionUpgradeEvents.html +++ b/types/_libp2p_interface.InboundConnectionUpgradeEvents.html @@ -1 +1 @@ -InboundConnectionUpgradeEvents | libp2p

                                                                                                                                                                                                                                      Type alias InboundConnectionUpgradeEvents

                                                                                                                                                                                                                                      InboundConnectionUpgradeEvents: ProgressEvent<"upgrader:encrypt-inbound-connection"> | ProgressEvent<"upgrader:multiplex-inbound-connection">

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +InboundConnectionUpgradeEvents | libp2p

                                                                                                                                                                                                                                      Type alias InboundConnectionUpgradeEvents

                                                                                                                                                                                                                                      InboundConnectionUpgradeEvents: ProgressEvent<"upgrader:encrypt-inbound-connection"> | ProgressEvent<"upgrader:multiplex-inbound-connection">

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.KeyType.html b/types/_libp2p_interface.KeyType.html index 251b497221..c3a3a6cbf5 100644 --- a/types/_libp2p_interface.KeyType.html +++ b/types/_libp2p_interface.KeyType.html @@ -1 +1 @@ -KeyType | libp2p

                                                                                                                                                                                                                                      Type alias KeyType

                                                                                                                                                                                                                                      KeyType: "RSA" | "Ed25519" | "secp256k1"

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +KeyType | libp2p

                                                                                                                                                                                                                                      Type alias KeyType

                                                                                                                                                                                                                                      KeyType: "RSA" | "Ed25519" | "secp256k1"

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.Libp2pStatus.html b/types/_libp2p_interface.Libp2pStatus.html index b356e92dd7..7fdf4c2c2a 100644 --- a/types/_libp2p_interface.Libp2pStatus.html +++ b/types/_libp2p_interface.Libp2pStatus.html @@ -1 +1 @@ -Libp2pStatus | libp2p

                                                                                                                                                                                                                                      Type alias Libp2pStatus

                                                                                                                                                                                                                                      Libp2pStatus: "starting" | "started" | "stopping" | "stopped"

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +Libp2pStatus | libp2p

                                                                                                                                                                                                                                      Type alias Libp2pStatus

                                                                                                                                                                                                                                      Libp2pStatus: "starting" | "started" | "stopping" | "stopped"

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.Message.html b/types/_libp2p_interface.Message.html index 223fe19bfd..a406bcee93 100644 --- a/types/_libp2p_interface.Message.html +++ b/types/_libp2p_interface.Message.html @@ -1 +1 @@ -Message | libp2p

                                                                                                                                                                                                                                      Type alias Message

                                                                                                                                                                                                                                      Message: SignedMessage | UnsignedMessage

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +Message | libp2p

                                                                                                                                                                                                                                      Type alias Message

                                                                                                                                                                                                                                      Message: SignedMessage | UnsignedMessage

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.OpenConnectionProgressEvents.html b/types/_libp2p_interface.OpenConnectionProgressEvents.html index cafa9f28f2..5b99511e79 100644 --- a/types/_libp2p_interface.OpenConnectionProgressEvents.html +++ b/types/_libp2p_interface.OpenConnectionProgressEvents.html @@ -1 +1 @@ -OpenConnectionProgressEvents | libp2p

                                                                                                                                                                                                                                      Type alias OpenConnectionProgressEvents

                                                                                                                                                                                                                                      OpenConnectionProgressEvents: TransportManagerDialProgressEvents | ProgressEvent<"dial-queue:already-connected"> | ProgressEvent<"dial-queue:already-in-dial-queue"> | ProgressEvent<"dial-queue:add-to-dial-queue"> | ProgressEvent<"dial-queue:start-dial"> | ProgressEvent<"dial-queue:calculated-addresses", Address[]> | OutboundConnectionUpgradeEvents

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +OpenConnectionProgressEvents | libp2p

                                                                                                                                                                                                                                      Type alias OpenConnectionProgressEvents

                                                                                                                                                                                                                                      OpenConnectionProgressEvents: TransportManagerDialProgressEvents | ProgressEvent<"dial-queue:already-connected"> | ProgressEvent<"dial-queue:already-in-dial-queue"> | ProgressEvent<"dial-queue:add-to-dial-queue"> | ProgressEvent<"dial-queue:start-dial"> | ProgressEvent<"dial-queue:calculated-addresses", Address[]> | OutboundConnectionUpgradeEvents

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.OutboundConnectionUpgradeEvents.html b/types/_libp2p_interface.OutboundConnectionUpgradeEvents.html index 37016fae53..44daf8d97b 100644 --- a/types/_libp2p_interface.OutboundConnectionUpgradeEvents.html +++ b/types/_libp2p_interface.OutboundConnectionUpgradeEvents.html @@ -1 +1 @@ -OutboundConnectionUpgradeEvents | libp2p

                                                                                                                                                                                                                                      Type alias OutboundConnectionUpgradeEvents

                                                                                                                                                                                                                                      OutboundConnectionUpgradeEvents: ProgressEvent<"upgrader:encrypt-outbound-connection"> | ProgressEvent<"upgrader:multiplex-outbound-connection">

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +OutboundConnectionUpgradeEvents | libp2p

                                                                                                                                                                                                                                      Type alias OutboundConnectionUpgradeEvents

                                                                                                                                                                                                                                      OutboundConnectionUpgradeEvents: ProgressEvent<"upgrader:encrypt-outbound-connection"> | ProgressEvent<"upgrader:multiplex-outbound-connection">

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.PeerId.html b/types/_libp2p_interface.PeerId.html index 7310a1a1ef..8a78047878 100644 --- a/types/_libp2p_interface.PeerId.html +++ b/types/_libp2p_interface.PeerId.html @@ -1,3 +1,3 @@ PeerId | libp2p

                                                                                                                                                                                                                                      Type alias PeerId

                                                                                                                                                                                                                                      PeerId: RSAPeerId | Ed25519PeerId | Secp256k1PeerId | URLPeerId

                                                                                                                                                                                                                                      This is a union of all known PeerId types - use the .type field to disambiguate them

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.PeerIdType.html b/types/_libp2p_interface.PeerIdType.html index f8fa53f3c1..370c9f26d9 100644 --- a/types/_libp2p_interface.PeerIdType.html +++ b/types/_libp2p_interface.PeerIdType.html @@ -1 +1 @@ -PeerIdType | libp2p

                                                                                                                                                                                                                                      Type alias PeerIdType

                                                                                                                                                                                                                                      PeerIdType: KeyType | string

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +PeerIdType | libp2p

                                                                                                                                                                                                                                      Type alias PeerIdType

                                                                                                                                                                                                                                      PeerIdType: KeyType | string

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.PendingDialStatus.html b/types/_libp2p_interface.PendingDialStatus.html index 900eff6798..008946c516 100644 --- a/types/_libp2p_interface.PendingDialStatus.html +++ b/types/_libp2p_interface.PendingDialStatus.html @@ -1 +1 @@ -PendingDialStatus | libp2p

                                                                                                                                                                                                                                      Type alias PendingDialStatus

                                                                                                                                                                                                                                      PendingDialStatus: "queued" | "active" | "error" | "success"

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +PendingDialStatus | libp2p

                                                                                                                                                                                                                                      Type alias PendingDialStatus

                                                                                                                                                                                                                                      PendingDialStatus: "queued" | "active" | "error" | "success"

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.PrivateKey.html b/types/_libp2p_interface.PrivateKey.html index e26878647c..2e8ed9bfcc 100644 --- a/types/_libp2p_interface.PrivateKey.html +++ b/types/_libp2p_interface.PrivateKey.html @@ -1 +1 @@ -PrivateKey | libp2p

                                                                                                                                                                                                                                      Type alias PrivateKey

                                                                                                                                                                                                                                      PrivateKey: RSAPrivateKey | Ed25519PrivateKey | Secp256k1PrivateKey

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +PrivateKey | libp2p

                                                                                                                                                                                                                                      Type alias PrivateKey

                                                                                                                                                                                                                                      PrivateKey: RSAPrivateKey | Ed25519PrivateKey | Secp256k1PrivateKey

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.PublicKey.html b/types/_libp2p_interface.PublicKey.html index e2fae516a2..8487f2126e 100644 --- a/types/_libp2p_interface.PublicKey.html +++ b/types/_libp2p_interface.PublicKey.html @@ -1 +1 @@ -PublicKey | libp2p

                                                                                                                                                                                                                                      Type alias PublicKey

                                                                                                                                                                                                                                      PublicKey: RSAPublicKey | Ed25519PublicKey | Secp256k1PublicKey

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +PublicKey | libp2p

                                                                                                                                                                                                                                      Type alias PublicKey

                                                                                                                                                                                                                                      PublicKey: RSAPublicKey | Ed25519PublicKey | Secp256k1PublicKey

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.ReadStatus.html b/types/_libp2p_interface.ReadStatus.html index 8cdb868fec..2ae168c85c 100644 --- a/types/_libp2p_interface.ReadStatus.html +++ b/types/_libp2p_interface.ReadStatus.html @@ -2,4 +2,4 @@

                                                                                                                                                                                                                                      ready - the readable end is ready for reading closing - the readable end is closing closed - the readable end has closed

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.ServiceMap.html b/types/_libp2p_interface.ServiceMap.html index 0e322264e0..a4d25a8ca2 100644 --- a/types/_libp2p_interface.ServiceMap.html +++ b/types/_libp2p_interface.ServiceMap.html @@ -2,4 +2,4 @@ services key

                                                                                                                                                                                                                                      Example

                                                                                                                                                                                                                                      const node = await createLibp2p({
                                                                                                                                                                                                                                        // ...other options
                                                                                                                                                                                                                                        services: {
                                                                                                                                                                                                                                          myService: myService({
                                                                                                                                                                                                                                            // ...service options
                                                                                                                                                                                                                                          })
                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                      })

                                                                                                                                                                                                                                      // invoke methods on the service
                                                                                                                                                                                                                                      node.services.myService.anOperation()
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.SignaturePolicy.html b/types/_libp2p_interface.SignaturePolicy.html index 1b9a48a6d9..80049897fc 100644 --- a/types/_libp2p_interface.SignaturePolicy.html +++ b/types/_libp2p_interface.SignaturePolicy.html @@ -1 +1 @@ -SignaturePolicy | libp2p

                                                                                                                                                                                                                                      Type alias SignaturePolicy

                                                                                                                                                                                                                                      SignaturePolicy: typeof StrictSign | typeof StrictNoSign

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +SignaturePolicy | libp2p

                                                                                                                                                                                                                                      Type alias SignaturePolicy

                                                                                                                                                                                                                                      SignaturePolicy: typeof StrictSign | typeof StrictNoSign

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.StreamStatus.html b/types/_libp2p_interface.StreamStatus.html index 83293c951b..663413e5a5 100644 --- a/types/_libp2p_interface.StreamStatus.html +++ b/types/_libp2p_interface.StreamStatus.html @@ -1,2 +1,2 @@ StreamStatus | libp2p

                                                                                                                                                                                                                                      Type alias StreamStatus

                                                                                                                                                                                                                                      StreamStatus: "open" | "closing" | "closed" | "aborted" | "reset"

                                                                                                                                                                                                                                      The states a stream can be in

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.TraceAttributes.html b/types/_libp2p_interface.TraceAttributes.html index a9b6592dee..fe1620d579 100644 --- a/types/_libp2p_interface.TraceAttributes.html +++ b/types/_libp2p_interface.TraceAttributes.html @@ -1 +1 @@ -TraceAttributes | libp2p

                                                                                                                                                                                                                                      Type alias TraceAttributes

                                                                                                                                                                                                                                      TraceAttributes: Record<string, number | string | boolean | number[] | string[] | boolean[]>

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +TraceAttributes | libp2p

                                                                                                                                                                                                                                      Type alias TraceAttributes

                                                                                                                                                                                                                                      TraceAttributes: Record<string, number | string | boolean | number[] | string[] | boolean[]>

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.TransportManagerDialProgressEvents.html b/types/_libp2p_interface.TransportManagerDialProgressEvents.html index 00d4c640d5..30bcafb786 100644 --- a/types/_libp2p_interface.TransportManagerDialProgressEvents.html +++ b/types/_libp2p_interface.TransportManagerDialProgressEvents.html @@ -1 +1 @@ -TransportManagerDialProgressEvents | libp2p

                                                                                                                                                                                                                                      Type alias TransportManagerDialProgressEvents

                                                                                                                                                                                                                                      TransportManagerDialProgressEvents: ProgressEvent<"transport-manager:selected-transport", string>

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +TransportManagerDialProgressEvents | libp2p

                                                                                                                                                                                                                                      Type alias TransportManagerDialProgressEvents

                                                                                                                                                                                                                                      TransportManagerDialProgressEvents: ProgressEvent<"transport-manager:selected-transport", string>

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface.WriteStatus.html b/types/_libp2p_interface.WriteStatus.html index 425b4aec42..d111a95c40 100644 --- a/types/_libp2p_interface.WriteStatus.html +++ b/types/_libp2p_interface.WriteStatus.html @@ -4,4 +4,4 @@ done - the source passed to the .sink function yielded all values without error closing - the writable end is closing closed - the writable end has closed

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_interface_internal.AddressType.html b/types/_libp2p_interface_internal.AddressType.html index be4ddfadf4..27041a7b09 100644 --- a/types/_libp2p_interface_internal.AddressType.html +++ b/types/_libp2p_interface_internal.AddressType.html @@ -6,4 +6,4 @@
                                                                                                                                                                                                                                    • 'dns-mapping' a DNS address dynamically mapped to one or more public addresses
                                                                                                                                                                                                                                    • 'ip-mapping' an external IP address dynamically mapped to a LAN address
                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_kad_dht.DHTProgressEvents.html b/types/_libp2p_kad_dht.DHTProgressEvents.html index ad3a7f91f2..3a23377c11 100644 --- a/types/_libp2p_kad_dht.DHTProgressEvents.html +++ b/types/_libp2p_kad_dht.DHTProgressEvents.html @@ -1 +1 @@ -DHTProgressEvents | libp2p

                                                                                                                                                                                                                                      Type alias DHTProgressEvents

                                                                                                                                                                                                                                      DHTProgressEvents: ProgressEvent<"kad-dht:query:send-query", SendQueryEvent> | ProgressEvent<"kad-dht:query:peer-response", PeerResponseEvent> | ProgressEvent<"kad-dht:query:final-peer", FinalPeerEvent> | ProgressEvent<"kad-dht:query:query-error", QueryErrorEvent> | ProgressEvent<"kad-dht:query:provider", ProviderEvent> | ProgressEvent<"kad-dht:query:value", ValueEvent> | ProgressEvent<"kad-dht:query:add-peer", AddPeerEvent> | ProgressEvent<"kad-dht:query:dial-peer", DialPeerEvent>

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +DHTProgressEvents | libp2p

                                                                                                                                                                                                                                      Type alias DHTProgressEvents

                                                                                                                                                                                                                                      DHTProgressEvents: ProgressEvent<"kad-dht:query:send-query", SendQueryEvent> | ProgressEvent<"kad-dht:query:peer-response", PeerResponseEvent> | ProgressEvent<"kad-dht:query:final-peer", FinalPeerEvent> | ProgressEvent<"kad-dht:query:query-error", QueryErrorEvent> | ProgressEvent<"kad-dht:query:provider", ProviderEvent> | ProgressEvent<"kad-dht:query:value", ValueEvent> | ProgressEvent<"kad-dht:query:add-peer", AddPeerEvent> | ProgressEvent<"kad-dht:query:dial-peer", DialPeerEvent>

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_kad_dht.MessageName.html b/types/_libp2p_kad_dht.MessageName.html index fd4592315c..976ee88153 100644 --- a/types/_libp2p_kad_dht.MessageName.html +++ b/types/_libp2p_kad_dht.MessageName.html @@ -1 +1 @@ -MessageName | libp2p

                                                                                                                                                                                                                                      Type alias MessageName

                                                                                                                                                                                                                                      MessageName: keyof typeof MessageType

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +MessageName | libp2p

                                                                                                                                                                                                                                      Type alias MessageName

                                                                                                                                                                                                                                      MessageName: keyof typeof MessageType

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_kad_dht.QueryEvent.html b/types/_libp2p_kad_dht.QueryEvent.html index a565709b38..51521ca373 100644 --- a/types/_libp2p_kad_dht.QueryEvent.html +++ b/types/_libp2p_kad_dht.QueryEvent.html @@ -1 +1 @@ -QueryEvent | libp2p

                                                                                                                                                                                                                                      Type alias QueryEvent

                                                                                                                                                                                                                                      QueryEvent: SendQueryEvent | PeerResponseEvent | FinalPeerEvent | QueryErrorEvent | ProviderEvent | ValueEvent | AddPeerEvent | DialPeerEvent

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +QueryEvent | libp2p

                                                                                                                                                                                                                                      Type alias QueryEvent

                                                                                                                                                                                                                                      QueryEvent: SendQueryEvent | PeerResponseEvent | FinalPeerEvent | QueryErrorEvent | ProviderEvent | ValueEvent | AddPeerEvent | DialPeerEvent

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_kad_dht.Selectors.html b/types/_libp2p_kad_dht.Selectors.html index f8e7fff003..76b983cd49 100644 --- a/types/_libp2p_kad_dht.Selectors.html +++ b/types/_libp2p_kad_dht.Selectors.html @@ -1,2 +1,2 @@ Selectors | libp2p

                                                                                                                                                                                                                                      Type alias Selectors

                                                                                                                                                                                                                                      Selectors: Record<string, SelectFn>

                                                                                                                                                                                                                                      Selectors are a map of key prefixes to selector functions

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_kad_dht.Validators.html b/types/_libp2p_kad_dht.Validators.html index 1bad75cf86..ff03b55807 100644 --- a/types/_libp2p_kad_dht.Validators.html +++ b/types/_libp2p_kad_dht.Validators.html @@ -1,2 +1,2 @@ Validators | libp2p

                                                                                                                                                                                                                                      Type alias Validators

                                                                                                                                                                                                                                      Validators: Record<string, ValidateFn>

                                                                                                                                                                                                                                      Validators are a map of key prefixes to validator functions

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_tcp.TCPDialEvents.html b/types/_libp2p_tcp.TCPDialEvents.html index 348ba63b10..3546876f20 100644 --- a/types/_libp2p_tcp.TCPDialEvents.html +++ b/types/_libp2p_tcp.TCPDialEvents.html @@ -1 +1 @@ -TCPDialEvents | libp2p

                                                                                                                                                                                                                                      Type alias TCPDialEvents

                                                                                                                                                                                                                                      TCPDialEvents: OutboundConnectionUpgradeEvents | ProgressEvent<"tcp:open-connection">

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +TCPDialEvents | libp2p

                                                                                                                                                                                                                                      Type alias TCPDialEvents

                                                                                                                                                                                                                                      TCPDialEvents: OutboundConnectionUpgradeEvents | ProgressEvent<"tcp:open-connection">

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_utils.queue.JobStatus.html b/types/_libp2p_utils.queue.JobStatus.html index fd51a76ffa..824346de46 100644 --- a/types/_libp2p_utils.queue.JobStatus.html +++ b/types/_libp2p_utils.queue.JobStatus.html @@ -1 +1 @@ -JobStatus | libp2p

                                                                                                                                                                                                                                      Type alias JobStatus

                                                                                                                                                                                                                                      JobStatus: "queued" | "running" | "errored" | "complete"

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +JobStatus | libp2p

                                                                                                                                                                                                                                      Type alias JobStatus

                                                                                                                                                                                                                                      JobStatus: "queued" | "running" | "errored" | "complete"

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_websockets.index.WebSocketsDialEvents.html b/types/_libp2p_websockets.index.WebSocketsDialEvents.html index 99e68013b6..1f86828728 100644 --- a/types/_libp2p_websockets.index.WebSocketsDialEvents.html +++ b/types/_libp2p_websockets.index.WebSocketsDialEvents.html @@ -1 +1 @@ -WebSocketsDialEvents | libp2p

                                                                                                                                                                                                                                      Type alias WebSocketsDialEvents

                                                                                                                                                                                                                                      WebSocketsDialEvents: OutboundConnectionUpgradeEvents | ProgressEvent<"websockets:open-connection">

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +WebSocketsDialEvents | libp2p

                                                                                                                                                                                                                                      Type alias WebSocketsDialEvents

                                                                                                                                                                                                                                      WebSocketsDialEvents: OutboundConnectionUpgradeEvents | ProgressEvent<"websockets:open-connection">

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/_libp2p_webtransport.WebTransportDialEvents.html b/types/_libp2p_webtransport.WebTransportDialEvents.html index 6172fe1a70..fd5f8afe50 100644 --- a/types/_libp2p_webtransport.WebTransportDialEvents.html +++ b/types/_libp2p_webtransport.WebTransportDialEvents.html @@ -1 +1 @@ -WebTransportDialEvents | libp2p

                                                                                                                                                                                                                                      Type alias WebTransportDialEvents

                                                                                                                                                                                                                                      WebTransportDialEvents: OutboundConnectionUpgradeEvents | ProgressEvent<"webtransport:wait-for-session"> | ProgressEvent<"webtransport:open-authentication-stream"> | ProgressEvent<"webtransport:secure-outbound-connection"> | ProgressEvent<"webtransport:close-authentication-stream">

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +WebTransportDialEvents | libp2p

                                                                                                                                                                                                                                      Type alias WebTransportDialEvents

                                                                                                                                                                                                                                      WebTransportDialEvents: OutboundConnectionUpgradeEvents | ProgressEvent<"webtransport:wait-for-session"> | ProgressEvent<"webtransport:open-authentication-stream"> | ProgressEvent<"webtransport:secure-outbound-connection"> | ProgressEvent<"webtransport:close-authentication-stream">

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/libp2p.index.Libp2pOptions.html b/types/libp2p.index.Libp2pOptions.html index 4ccd7f36ce..f966bcdaab 100644 --- a/types/libp2p.index.Libp2pOptions.html +++ b/types/libp2p.index.Libp2pOptions.html @@ -1 +1 @@ -Libp2pOptions | libp2p

                                                                                                                                                                                                                                      Type alias Libp2pOptions<T>

                                                                                                                                                                                                                                      Libp2pOptions<T>: Libp2pInit<T> & {
                                                                                                                                                                                                                                          start?: boolean;
                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                      • Optional start?: boolean

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +Libp2pOptions | libp2p

                                                                                                                                                                                                                                      Type alias Libp2pOptions<T>

                                                                                                                                                                                                                                      Libp2pOptions<T>: Libp2pInit<T> & {
                                                                                                                                                                                                                                          start?: boolean;
                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                      • Optional start?: boolean

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/types/libp2p.index.ServiceFactoryMap.html b/types/libp2p.index.ServiceFactoryMap.html index 80dbb4ad6e..c556972c64 100644 --- a/types/libp2p.index.ServiceFactoryMap.html +++ b/types/libp2p.index.ServiceFactoryMap.html @@ -1 +1 @@ -ServiceFactoryMap | libp2p

                                                                                                                                                                                                                                      Type alias ServiceFactoryMap<T>

                                                                                                                                                                                                                                      ServiceFactoryMap<T>: {
                                                                                                                                                                                                                                          [Property in keyof T]: ((components) => T[Property])
                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +ServiceFactoryMap | libp2p

                                                                                                                                                                                                                                      Type alias ServiceFactoryMap<T>

                                                                                                                                                                                                                                      ServiceFactoryMap<T>: {
                                                                                                                                                                                                                                          [Property in keyof T]: ((components) => T[Property])
                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_circuit_relay_v2.RELAY_V2_HOP_CODEC.html b/variables/_libp2p_circuit_relay_v2.RELAY_V2_HOP_CODEC.html index 5cb1f6d15f..d8686995f0 100644 --- a/variables/_libp2p_circuit_relay_v2.RELAY_V2_HOP_CODEC.html +++ b/variables/_libp2p_circuit_relay_v2.RELAY_V2_HOP_CODEC.html @@ -1,2 +1,2 @@ RELAY_V2_HOP_CODEC | libp2p

                                                                                                                                                                                                                                      Variable RELAY_V2_HOP_CODECConst

                                                                                                                                                                                                                                      RELAY_V2_HOP_CODEC: "/libp2p/circuit/relay/0.2.0/hop" = '/libp2p/circuit/relay/0.2.0/hop'

                                                                                                                                                                                                                                      The hop protocol

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_circuit_relay_v2.RELAY_V2_STOP_CODEC.html b/variables/_libp2p_circuit_relay_v2.RELAY_V2_STOP_CODEC.html index 732c8414ec..3a3de2a4ad 100644 --- a/variables/_libp2p_circuit_relay_v2.RELAY_V2_STOP_CODEC.html +++ b/variables/_libp2p_circuit_relay_v2.RELAY_V2_STOP_CODEC.html @@ -1,2 +1,2 @@ RELAY_V2_STOP_CODEC | libp2p

                                                                                                                                                                                                                                      Variable RELAY_V2_STOP_CODECConst

                                                                                                                                                                                                                                      RELAY_V2_STOP_CODEC: "/libp2p/circuit/relay/0.2.0/stop" = '/libp2p/circuit/relay/0.2.0/stop'

                                                                                                                                                                                                                                      the stop protocol

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_crypto.webcrypto.default.html b/variables/_libp2p_crypto.webcrypto.default.html index 56b28cea17..5bc2c6b4c3 100644 --- a/variables/_libp2p_crypto.webcrypto.default.html +++ b/variables/_libp2p_crypto.webcrypto.default.html @@ -1 +1 @@ -default | libp2p

                                                                                                                                                                                                                                      Variable default

                                                                                                                                                                                                                                      default: {
                                                                                                                                                                                                                                          get(win?): Crypto;
                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +default | libp2p

                                                                                                                                                                                                                                      Variable default

                                                                                                                                                                                                                                      default: {
                                                                                                                                                                                                                                          get(win?): Crypto;
                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_dcutr.multicodec.html b/variables/_libp2p_dcutr.multicodec.html index 27618b8332..5d08162b67 100644 --- a/variables/_libp2p_dcutr.multicodec.html +++ b/variables/_libp2p_dcutr.multicodec.html @@ -1,2 +1,2 @@ multicodec | libp2p

                                                                                                                                                                                                                                      Variable multicodecConst

                                                                                                                                                                                                                                      multicodec: "/libp2p/dcutr" = '/libp2p/dcutr'

                                                                                                                                                                                                                                      The DCUtR protocol

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_devtools_metrics.index.LIBP2P_DEVTOOLS_METRICS_KEY.html b/variables/_libp2p_devtools_metrics.index.LIBP2P_DEVTOOLS_METRICS_KEY.html index 175cc35ff5..29ecc5e878 100644 --- a/variables/_libp2p_devtools_metrics.index.LIBP2P_DEVTOOLS_METRICS_KEY.html +++ b/variables/_libp2p_devtools_metrics.index.LIBP2P_DEVTOOLS_METRICS_KEY.html @@ -1 +1 @@ -LIBP2P_DEVTOOLS_METRICS_KEY | libp2p

                                                                                                                                                                                                                                      Variable LIBP2P_DEVTOOLS_METRICS_KEYConst

                                                                                                                                                                                                                                      LIBP2P_DEVTOOLS_METRICS_KEY: "________libp2p_devtools_metrics" = '________libp2p_devtools_metrics'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +LIBP2P_DEVTOOLS_METRICS_KEY | libp2p

                                                                                                                                                                                                                                      Variable LIBP2P_DEVTOOLS_METRICS_KEYConst

                                                                                                                                                                                                                                      LIBP2P_DEVTOOLS_METRICS_KEY: "________libp2p_devtools_metrics" = '________libp2p_devtools_metrics'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_devtools_metrics.index.SOURCE_CONTENT_SCRIPT.html b/variables/_libp2p_devtools_metrics.index.SOURCE_CONTENT_SCRIPT.html index f2cf5061ec..cbec9d3416 100644 --- a/variables/_libp2p_devtools_metrics.index.SOURCE_CONTENT_SCRIPT.html +++ b/variables/_libp2p_devtools_metrics.index.SOURCE_CONTENT_SCRIPT.html @@ -1 +1 @@ -SOURCE_CONTENT_SCRIPT | libp2p

                                                                                                                                                                                                                                      Variable SOURCE_CONTENT_SCRIPTConst

                                                                                                                                                                                                                                      SOURCE_CONTENT_SCRIPT: "@libp2p/devtools-metrics:content" = '@libp2p/devtools-metrics:content'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +SOURCE_CONTENT_SCRIPT | libp2p

                                                                                                                                                                                                                                      Variable SOURCE_CONTENT_SCRIPTConst

                                                                                                                                                                                                                                      SOURCE_CONTENT_SCRIPT: "@libp2p/devtools-metrics:content" = '@libp2p/devtools-metrics:content'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_devtools_metrics.index.SOURCE_DEVTOOLS.html b/variables/_libp2p_devtools_metrics.index.SOURCE_DEVTOOLS.html index 95fbddf7b9..7e1ae682e3 100644 --- a/variables/_libp2p_devtools_metrics.index.SOURCE_DEVTOOLS.html +++ b/variables/_libp2p_devtools_metrics.index.SOURCE_DEVTOOLS.html @@ -1 +1 @@ -SOURCE_DEVTOOLS | libp2p

                                                                                                                                                                                                                                      Variable SOURCE_DEVTOOLSConst

                                                                                                                                                                                                                                      SOURCE_DEVTOOLS: "@libp2p/devtools-metrics:devtools" = '@libp2p/devtools-metrics:devtools'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +SOURCE_DEVTOOLS | libp2p

                                                                                                                                                                                                                                      Variable SOURCE_DEVTOOLSConst

                                                                                                                                                                                                                                      SOURCE_DEVTOOLS: "@libp2p/devtools-metrics:devtools" = '@libp2p/devtools-metrics:devtools'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_devtools_metrics.index.SOURCE_METRICS.html b/variables/_libp2p_devtools_metrics.index.SOURCE_METRICS.html index cfbb3a5a39..88245fd7b4 100644 --- a/variables/_libp2p_devtools_metrics.index.SOURCE_METRICS.html +++ b/variables/_libp2p_devtools_metrics.index.SOURCE_METRICS.html @@ -1 +1 @@ -SOURCE_METRICS | libp2p

                                                                                                                                                                                                                                      Variable SOURCE_METRICSConst

                                                                                                                                                                                                                                      SOURCE_METRICS: "@libp2p/devtools-metrics:metrics" = '@libp2p/devtools-metrics:metrics'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +SOURCE_METRICS | libp2p

                                                                                                                                                                                                                                      Variable SOURCE_METRICSConst

                                                                                                                                                                                                                                      SOURCE_METRICS: "@libp2p/devtools-metrics:metrics" = '@libp2p/devtools-metrics:metrics'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_devtools_metrics.index.SOURCE_SERVICE_WORKER.html b/variables/_libp2p_devtools_metrics.index.SOURCE_SERVICE_WORKER.html index d1d6375253..2a730fd221 100644 --- a/variables/_libp2p_devtools_metrics.index.SOURCE_SERVICE_WORKER.html +++ b/variables/_libp2p_devtools_metrics.index.SOURCE_SERVICE_WORKER.html @@ -1 +1 @@ -SOURCE_SERVICE_WORKER | libp2p

                                                                                                                                                                                                                                      Variable SOURCE_SERVICE_WORKERConst

                                                                                                                                                                                                                                      SOURCE_SERVICE_WORKER: "@libp2p/devtools-metrics:worker" = '@libp2p/devtools-metrics:worker'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +SOURCE_SERVICE_WORKER | libp2p

                                                                                                                                                                                                                                      Variable SOURCE_SERVICE_WORKERConst

                                                                                                                                                                                                                                      SOURCE_SERVICE_WORKER: "@libp2p/devtools-metrics:worker" = '@libp2p/devtools-metrics:worker'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_devtools_metrics.rpc.valueCodecs.html b/variables/_libp2p_devtools_metrics.rpc.valueCodecs.html index 122593bd80..7940711716 100644 --- a/variables/_libp2p_devtools_metrics.rpc.valueCodecs.html +++ b/variables/_libp2p_devtools_metrics.rpc.valueCodecs.html @@ -1 +1 @@ -valueCodecs | libp2p

                                                                                                                                                                                                                                      Variable valueCodecsConst

                                                                                                                                                                                                                                      valueCodecs: ValueCodec<any>[] = ...

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +valueCodecs | libp2p

                                                                                                                                                                                                                                      Variable valueCodecsConst

                                                                                                                                                                                                                                      valueCodecs: ValueCodec<any>[] = ...

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_floodsub.multicodec.html b/variables/_libp2p_floodsub.multicodec.html index df984ae806..15696873a8 100644 --- a/variables/_libp2p_floodsub.multicodec.html +++ b/variables/_libp2p_floodsub.multicodec.html @@ -1 +1 @@ -multicodec | libp2p

                                                                                                                                                                                                                                      Variable multicodecConst

                                                                                                                                                                                                                                      multicodec: "/floodsub/1.0.0" = '/floodsub/1.0.0'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +multicodec | libp2p

                                                                                                                                                                                                                                      Variable multicodecConst

                                                                                                                                                                                                                                      multicodec: "/floodsub/1.0.0" = '/floodsub/1.0.0'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_interface.KEEP_ALIVE.html b/variables/_libp2p_interface.KEEP_ALIVE.html index 605758e51d..bdc0124461 100644 --- a/variables/_libp2p_interface.KEEP_ALIVE.html +++ b/variables/_libp2p_interface.KEEP_ALIVE.html @@ -3,4 +3,4 @@

                                                                                                                                                                                                                                      To allow multiple components to add/remove their own keep-alive tags without accidentally overwriting those of other components, attach a unique suffix to the tag, e.g. keep-alive-circuit-relay or keep-alive-kad-dht, etc.

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_interface.StrictNoSign.html b/variables/_libp2p_interface.StrictNoSign.html index de7c98a5c5..b2b7db45ba 100644 --- a/variables/_libp2p_interface.StrictNoSign.html +++ b/variables/_libp2p_interface.StrictNoSign.html @@ -9,4 +9,4 @@
                                                                                                                                                                                                                                    • Propagate only if the fields are absent, reject otherwise.
                                                                                                                                                                                                                                    • A message_id function will not be able to use the above fields, and should instead rely on the data field. A commonplace strategy is to calculate a hash.
                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_interface.StrictSign.html b/variables/_libp2p_interface.StrictSign.html index ea0a67a25d..5724b3de5c 100644 --- a/variables/_libp2p_interface.StrictSign.html +++ b/variables/_libp2p_interface.StrictSign.html @@ -7,4 +7,4 @@
                                                                                                                                                                                                                                    • Enforce the fields to be present, reject otherwise.
                                                                                                                                                                                                                                    • Propagate only if the fields are valid and signature can be verified, reject otherwise.
                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_interface.connectionSymbol.html b/variables/_libp2p_interface.connectionSymbol.html index 0e1e76b1b6..6b149563d0 100644 --- a/variables/_libp2p_interface.connectionSymbol.html +++ b/variables/_libp2p_interface.connectionSymbol.html @@ -1 +1 @@ -connectionSymbol | libp2p

                                                                                                                                                                                                                                      Variable connectionSymbolConst

                                                                                                                                                                                                                                      connectionSymbol: typeof connectionSymbol = ...

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +connectionSymbol | libp2p

                                                                                                                                                                                                                                      Variable connectionSymbolConst

                                                                                                                                                                                                                                      connectionSymbol: typeof connectionSymbol = ...

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_interface.contentRoutingSymbol.html b/variables/_libp2p_interface.contentRoutingSymbol.html index ba29b91b79..109c9ac97a 100644 --- a/variables/_libp2p_interface.contentRoutingSymbol.html +++ b/variables/_libp2p_interface.contentRoutingSymbol.html @@ -3,4 +3,4 @@ Symbol.Iterable can be used to return an Iterable from an Iterator.

                                                                                                                                                                                                                                      Example

                                                                                                                                                                                                                                      import { contentRoutingSymbol, ContentRouting } from '@libp2p/content-routing'

                                                                                                                                                                                                                                      class MyContentRouter implements ContentRouting {
                                                                                                                                                                                                                                        get [contentRoutingSymbol] () {
                                                                                                                                                                                                                                          return this
                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                        // ...other methods
                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_interface.peerDiscoverySymbol.html b/variables/_libp2p_interface.peerDiscoverySymbol.html index 1ab2d883d9..3a984e6bde 100644 --- a/variables/_libp2p_interface.peerDiscoverySymbol.html +++ b/variables/_libp2p_interface.peerDiscoverySymbol.html @@ -3,4 +3,4 @@ Symbol.Iterable can be used to return an Iterable from an Iterator.

                                                                                                                                                                                                                                      Example

                                                                                                                                                                                                                                      import { peerDiscovery, PeerDiscovery } from '@libp2p/peer-discovery'

                                                                                                                                                                                                                                      class MyPeerDiscoverer implements PeerDiscovery {
                                                                                                                                                                                                                                        get [peerDiscovery] () {
                                                                                                                                                                                                                                          return this
                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                        // ...other methods
                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_interface.peerIdSymbol.html b/variables/_libp2p_interface.peerIdSymbol.html index 0fc5b0ce53..19b4ee3bf0 100644 --- a/variables/_libp2p_interface.peerIdSymbol.html +++ b/variables/_libp2p_interface.peerIdSymbol.html @@ -1,3 +1,3 @@ peerIdSymbol | libp2p

                                                                                                                                                                                                                                      Variable peerIdSymbolConst

                                                                                                                                                                                                                                      peerIdSymbol: typeof peerIdSymbol = ...

                                                                                                                                                                                                                                      All PeerId implementations must use this symbol as the name of a property with a boolean true value

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_interface.peerRoutingSymbol.html b/variables/_libp2p_interface.peerRoutingSymbol.html index 81f2447741..3b40446297 100644 --- a/variables/_libp2p_interface.peerRoutingSymbol.html +++ b/variables/_libp2p_interface.peerRoutingSymbol.html @@ -3,4 +3,4 @@ Symbol.Iterable can be used to return an Iterable from an Iterator.

                                                                                                                                                                                                                                      Example

                                                                                                                                                                                                                                      import { peerRouting, PeerRouting } from '@libp2p/peer-routing'

                                                                                                                                                                                                                                      class MyPeerRouter implements PeerRouting {
                                                                                                                                                                                                                                        get [peerRouting] () {
                                                                                                                                                                                                                                          return this
                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                        // ...other methods
                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_interface.pubSubSymbol.html b/variables/_libp2p_interface.pubSubSymbol.html index d06b1ae7d0..0fb8ecacd1 100644 --- a/variables/_libp2p_interface.pubSubSymbol.html +++ b/variables/_libp2p_interface.pubSubSymbol.html @@ -1,3 +1,3 @@ pubSubSymbol | libp2p

                                                                                                                                                                                                                                      Variable pubSubSymbolConst

                                                                                                                                                                                                                                      pubSubSymbol: typeof pubSubSymbol = ...

                                                                                                                                                                                                                                      All Pubsub implementations must use this symbol as the name of a property with a boolean true value

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_interface.serviceCapabilities.html b/variables/_libp2p_interface.serviceCapabilities.html index dee2e00c7c..80d0f7bd7f 100644 --- a/variables/_libp2p_interface.serviceCapabilities.html +++ b/variables/_libp2p_interface.serviceCapabilities.html @@ -2,4 +2,4 @@ provide to other libp2p services.

                                                                                                                                                                                                                                      The service should define a property with this symbol as the key and the value should be a string array of provided capabilities.

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_interface.serviceDependencies.html b/variables/_libp2p_interface.serviceDependencies.html index 84fdb9eeef..469e679c08 100644 --- a/variables/_libp2p_interface.serviceDependencies.html +++ b/variables/_libp2p_interface.serviceDependencies.html @@ -2,4 +2,4 @@ require from other libp2p services.

                                                                                                                                                                                                                                      The service should define a property with this symbol as the key and the value should be a string array of required capabilities.

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_interface.transportSymbol.html b/variables/_libp2p_interface.transportSymbol.html index e0a256c49c..aec0049e6b 100644 --- a/variables/_libp2p_interface.transportSymbol.html +++ b/variables/_libp2p_interface.transportSymbol.html @@ -1 +1 @@ -transportSymbol | libp2p

                                                                                                                                                                                                                                      Variable transportSymbolConst

                                                                                                                                                                                                                                      transportSymbol: typeof transportSymbol = ...

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +transportSymbol | libp2p

                                                                                                                                                                                                                                      Variable transportSymbolConst

                                                                                                                                                                                                                                      transportSymbol: typeof transportSymbol = ...

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_interface_compliance_tests.mocks.mockNetwork-1.html b/variables/_libp2p_interface_compliance_tests.mocks.mockNetwork-1.html index 24266f8b19..19d92a4bde 100644 --- a/variables/_libp2p_interface_compliance_tests.mocks.mockNetwork-1.html +++ b/variables/_libp2p_interface_compliance_tests.mocks.mockNetwork-1.html @@ -1 +1 @@ -mockNetwork | libp2p

                                                                                                                                                                                                                                      Variable mockNetworkConst

                                                                                                                                                                                                                                      mockNetwork: MockNetwork = ...

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +mockNetwork | libp2p

                                                                                                                                                                                                                                      Variable mockNetworkConst

                                                                                                                                                                                                                                      mockNetwork: MockNetwork = ...

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_multistream_select.PROTOCOL_ID.html b/variables/_libp2p_multistream_select.PROTOCOL_ID.html index 6bd70d7849..9617d072c4 100644 --- a/variables/_libp2p_multistream_select.PROTOCOL_ID.html +++ b/variables/_libp2p_multistream_select.PROTOCOL_ID.html @@ -1 +1 @@ -PROTOCOL_ID | libp2p

                                                                                                                                                                                                                                      Variable PROTOCOL_IDConst

                                                                                                                                                                                                                                      PROTOCOL_ID: "/multistream/1.0.0" = '/multistream/1.0.0'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +PROTOCOL_ID | libp2p

                                                                                                                                                                                                                                      Variable PROTOCOL_IDConst

                                                                                                                                                                                                                                      PROTOCOL_ID: "/multistream/1.0.0" = '/multistream/1.0.0'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_ping.PING_PROTOCOL.html b/variables/_libp2p_ping.PING_PROTOCOL.html index aeb6b94d1c..06fd452990 100644 --- a/variables/_libp2p_ping.PING_PROTOCOL.html +++ b/variables/_libp2p_ping.PING_PROTOCOL.html @@ -1 +1 @@ -PING_PROTOCOL | libp2p

                                                                                                                                                                                                                                      Variable PING_PROTOCOLConst

                                                                                                                                                                                                                                      PING_PROTOCOL: "/ipfs/ping/1.0.0" = '/ipfs/ping/1.0.0'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +PING_PROTOCOL | libp2p

                                                                                                                                                                                                                                      Variable PING_PROTOCOLConst

                                                                                                                                                                                                                                      PING_PROTOCOL: "/ipfs/ping/1.0.0" = '/ipfs/ping/1.0.0'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_tls.PROTOCOL.html b/variables/_libp2p_tls.PROTOCOL.html index 30239d1c1c..a1ac3fccd0 100644 --- a/variables/_libp2p_tls.PROTOCOL.html +++ b/variables/_libp2p_tls.PROTOCOL.html @@ -1 +1 @@ -PROTOCOL | libp2p

                                                                                                                                                                                                                                      Variable PROTOCOLConst

                                                                                                                                                                                                                                      PROTOCOL: "/tls/1.0.0" = '/tls/1.0.0'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +PROTOCOL | libp2p

                                                                                                                                                                                                                                      Variable PROTOCOLConst

                                                                                                                                                                                                                                      PROTOCOL: "/tls/1.0.0" = '/tls/1.0.0'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_utils.adaptive_timeout.DEFAULT_FAILURE_MULTIPLIER.html b/variables/_libp2p_utils.adaptive_timeout.DEFAULT_FAILURE_MULTIPLIER.html index ab961ee5a4..0c0e7da2f6 100644 --- a/variables/_libp2p_utils.adaptive_timeout.DEFAULT_FAILURE_MULTIPLIER.html +++ b/variables/_libp2p_utils.adaptive_timeout.DEFAULT_FAILURE_MULTIPLIER.html @@ -1 +1 @@ -DEFAULT_FAILURE_MULTIPLIER | libp2p

                                                                                                                                                                                                                                      Variable DEFAULT_FAILURE_MULTIPLIERConst

                                                                                                                                                                                                                                      DEFAULT_FAILURE_MULTIPLIER: 2 = 2

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +DEFAULT_FAILURE_MULTIPLIER | libp2p

                                                                                                                                                                                                                                      Variable DEFAULT_FAILURE_MULTIPLIERConst

                                                                                                                                                                                                                                      DEFAULT_FAILURE_MULTIPLIER: 2 = 2

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_utils.adaptive_timeout.DEFAULT_MIN_TIMEOUT.html b/variables/_libp2p_utils.adaptive_timeout.DEFAULT_MIN_TIMEOUT.html index cc4ace49db..809044a037 100644 --- a/variables/_libp2p_utils.adaptive_timeout.DEFAULT_MIN_TIMEOUT.html +++ b/variables/_libp2p_utils.adaptive_timeout.DEFAULT_MIN_TIMEOUT.html @@ -1 +1 @@ -DEFAULT_MIN_TIMEOUT | libp2p

                                                                                                                                                                                                                                      Variable DEFAULT_MIN_TIMEOUTConst

                                                                                                                                                                                                                                      DEFAULT_MIN_TIMEOUT: 2000 = 2000

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +DEFAULT_MIN_TIMEOUT | libp2p

                                                                                                                                                                                                                                      Variable DEFAULT_MIN_TIMEOUTConst

                                                                                                                                                                                                                                      DEFAULT_MIN_TIMEOUT: 2000 = 2000

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/_libp2p_utils.adaptive_timeout.DEFAULT_TIMEOUT_MULTIPLIER.html b/variables/_libp2p_utils.adaptive_timeout.DEFAULT_TIMEOUT_MULTIPLIER.html index 22511fa14f..4f42537281 100644 --- a/variables/_libp2p_utils.adaptive_timeout.DEFAULT_TIMEOUT_MULTIPLIER.html +++ b/variables/_libp2p_utils.adaptive_timeout.DEFAULT_TIMEOUT_MULTIPLIER.html @@ -1 +1 @@ -DEFAULT_TIMEOUT_MULTIPLIER | libp2p

                                                                                                                                                                                                                                      Variable DEFAULT_TIMEOUT_MULTIPLIERConst

                                                                                                                                                                                                                                      DEFAULT_TIMEOUT_MULTIPLIER: 1.2 = 1.2

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +DEFAULT_TIMEOUT_MULTIPLIER | libp2p

                                                                                                                                                                                                                                      Variable DEFAULT_TIMEOUT_MULTIPLIERConst

                                                                                                                                                                                                                                      DEFAULT_TIMEOUT_MULTIPLIER: 1.2 = 1.2

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/libp2p.version.name.html b/variables/libp2p.version.name.html index 08ad0e919c..5e78afbe6f 100644 --- a/variables/libp2p.version.name.html +++ b/variables/libp2p.version.name.html @@ -1 +1 @@ -name | libp2p

                                                                                                                                                                                                                                      Variable nameConst

                                                                                                                                                                                                                                      name: "js-libp2p" = 'js-libp2p'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +name | libp2p

                                                                                                                                                                                                                                      Variable nameConst

                                                                                                                                                                                                                                      name: "js-libp2p" = 'js-libp2p'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/variables/libp2p.version.version.html b/variables/libp2p.version.version.html index 094e619d6f..55e723fca0 100644 --- a/variables/libp2p.version.version.html +++ b/variables/libp2p.version.version.html @@ -1 +1 @@ -version | libp2p

                                                                                                                                                                                                                                      Variable versionConst

                                                                                                                                                                                                                                      version: "2.5.0" = '2.5.0'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file +version | libp2p

                                                                                                                                                                                                                                      Variable versionConst

                                                                                                                                                                                                                                      version: "2.5.0" = '2.5.0'

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      \ No newline at end of file