+
+
+
+
+ Class Connection
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_crypto_errors_.invalidcryptoexchangeerror.html b/classes/_crypto_errors_.invalidcryptoexchangeerror.html
new file mode 100644
index 0000000..6c01c9a
--- /dev/null
+++ b/classes/_crypto_errors_.invalidcryptoexchangeerror.html
@@ -0,0 +1,367 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Conection
+ Re-exports ConectionStat
+
+
+
+ Connection
+ Re-exports ConnectionOptions
+
+
+
+ Muxed
+ Re-exports MuxedStream
+
+
+
+
+
+
+ Stream
+ Re-exports StreamData
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ _get
+
+
+
+
+
+ _new
+
+
+
+
+
+
+
+
+
+
+
+ local
+
+
+
+
+
+ local
+
+
+
+
+
+
+
+
+ remote
+
+
+
+
+
+ remote
+
+
+
+
+
+
+
+
+
+
+ [
+
+
+
+
+
+
+
+
+
+
+
+ add
+
+
+
+
+
+
+ new
+
+
+
+ remove
+
+
+
+ Static is
+
+
+
+
+ Hierarchy
+-
+
- + Connection + +
Index
+
+
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- Conection
Stat
+ - Connection
Options
+ - Muxed
Stream
+ - Status +
- Stream
Data
+ - Timeline +
Constructors
+-
+
- constructor +
Properties
+-
+
- _close +
- _closing +
- _get
Streams
+ - _new
Stream
+ - _stat +
- id +
- local
Addr
+ - local
Peer
+ - registry +
- remote
Addr
+ - remote
Peer
+ - tags +
Accessors
+-
+
- [
Symbol.to String Tag]
+ - stat +
- streams +
Methods
+-
+
- add
Stream
+ - close +
- new
Stream
+ - remove
Stream
+ - is
Connection
+
References
+ConectionStat
+ Re-exports ConectionStat
+ ConnectionOptions
+ Re-exports ConnectionOptions
+ MuxedStream
+ Re-exports MuxedStream
+ Status
+ Re-exports Status +StreamData
+ Re-exports StreamData
+ Timeline
+ Re-exports Timeline +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
An implementation of the js-libp2p connection. + Any libp2p transport should use an upgrader to return this connection.
+Parameters
+-
+
-
+
__namedParameters: { close: () => Promise<void>; getStreams: () => MuxedStream[]; localAddr: undefined | Multiaddr; localPeer: PeerId; newStream: (protocols: string | string[]) => Promise<{ protocol: string; stream: MuxedStream }>; remoteAddr: Multiaddr; remotePeer: PeerId; stat: ConectionStat }
+-
+
-
+
close: () => Promise<void>
+-
+
-
+
-
+
+
-
+
-
+
Returns Promise<void>
+
+
+ -
+
+ -
+
-
+
get
+Streams: () => MuxedStream[] -
+
-
+
-
+
+
-
+
-
+
Returns MuxedStream[]
+
+
+ -
+
+ -
+
-
+
local
+Addr: undefined | Multiaddr
+ -
+
local
+Peer: PeerId
+ -
+
new
+Stream: (protocols: string | string[]) => Promise<{ protocol: string; stream: MuxedStream }> -
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
protocols: string | string[]
+
+
Returns Promise<{ protocol: string; stream: MuxedStream }>
+
+ -
+
+ -
+
+ -
+
-
+
remote
+Addr: Multiaddr
+ -
+
remote
+Peer: PeerId
+ -
+
stat: ConectionStat
+
+
+ -
+
Returns Connection
+
+ -
+
Properties
+_close
+ + +
+
+
+
+ Reference to the close function of the raw connection
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Returns Promise<void>
+
+
+ -
+
_closing
+ + +_getStreams
+
+
+
+
+
+
+ Reference to the getStreams function of the muxer
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Returns MuxedStream[]
+
+
+ -
+
_newStream
+
+
+
+
+
+
+ Reference to the new stream function of the multiplexer
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
protocols: string | string[]
+
+
Returns Promise<{ protocol: string; stream: MuxedStream }>
+
+ -
+
+ -
+
_stat
+ + +
+
+
+
+ Connection metadata.
+id
+ + +
+
+
+
+ Connection identifier.
+localAddr
+
+
+
+
+
+
+ Observed multiaddr of the local peer
+localPeer
+
+
+
+
+
+
+ Local peer id.
+registry
+ + +
+
+
+
+ Connection streams registry
+remoteAddr
+
+
+
+
+
+
+ Observed multiaddr of the remote peer
+remotePeer
+
+
+
+
+
+
+ Remote peer id.
+tags
+ + +
+
+
+
+ User provided tags
+Accessors
+[Symbol.toStringTag]
+ -
+
+
-
+
-
+
+
Returns string
+
+
stat
+-
+
+
-
+
-
+
+ ++++
Get connection metadata
+Returns ConectionStat & { status: Status }
+
+
streams
+-
+
+
-
+
-
+
+ ++++
Get all the streams of the muxer.
+Returns MuxedStream[]
+
+
Methods
+addStream
+ -
+
+
-
+
-
+
+ ++++
Add a stream when it is opened to the registry.
+Parameters
+-
+
-
+
muxedStream: MuxedStream
+++a muxed stream
+
+ -
+
__namedParameters: { metadata: any; protocol: string }
+-
+
-
+
metadata: any
+
+ -
+
protocol: string
+
+
+ -
+
Returns void
+
+ -
+
close
+-
+
+
-
+
-
+
+ ++++
Close the connection.
+Returns Promise<void>
+
+
newStream
+ -
+
+
-
+
-
+
+ ++++
Create a new stream from this connection
+Parameters
+-
+
-
+
protocols: string | string[]
+++intended protocol for the stream
+
+
Returns Promise<{ protocol: string; stream: MuxedStream }>
++
+} with muxed+multistream-selected stream and selected protocol
+
+ -
+
removeStream
+ -
+
+
-
+
-
+
+ ++++
Remove stream registry after it is closed.
+Parameters
+-
+
-
+
id: string
+++identifier of the stream
+
+
Returns void
+
+ -
+
Static isConnection
+ -
+
+
-
+
-
+
+ ++++
Checks if the given value is a
+Connectioninstance.Parameters
+-
+
-
+
other: any
+
+
Returns other is Connection
+
+ -
+
+
+
+
+
+ Class InvalidCryptoExchangeError
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_crypto_errors_.invalidcryptotransmissionerror.html b/classes/_crypto_errors_.invalidcryptotransmissionerror.html
new file mode 100644
index 0000000..9588cbc
--- /dev/null
+++ b/classes/_crypto_errors_.invalidcryptotransmissionerror.html
@@ -0,0 +1,367 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ Error
+
-
+
- + InvalidCryptoExchangeError + +
+
Index
+Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional message: undefined | string
+
+
Returns InvalidCryptoExchangeError
+
+ -
+
Properties
+code
+ + +message
+ + +name
+ + +Optional stack
+ + +Static Error
+ + +Accessors
+Static code
+-
+
+
-
+
-
+
+
Returns string
+
+
+
+
+
+
+ Class InvalidCryptoTransmissionError
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_crypto_errors_.unexpectedpeererror.html b/classes/_crypto_errors_.unexpectedpeererror.html
new file mode 100644
index 0000000..5c6d1d6
--- /dev/null
+++ b/classes/_crypto_errors_.unexpectedpeererror.html
@@ -0,0 +1,367 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ Error
+
-
+
- + InvalidCryptoTransmissionError + +
+
Index
+Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional message: undefined | string
+
+
Returns InvalidCryptoTransmissionError
+
+ -
+
Properties
+code
+ + +message
+ + +name
+ + +Optional stack
+ + +Static Error
+ + +Accessors
+Static code
+-
+
+
-
+
-
+
+
Returns string
+
+
+
+
+
+
+ Class UnexpectedPeerError
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_pubsub_index_.pubsubbaseprotocol.html b/classes/_pubsub_index_.pubsubbaseprotocol.html
new file mode 100644
index 0000000..057ca8a
--- /dev/null
+++ b/classes/_pubsub_index_.pubsubbaseprotocol.html
@@ -0,0 +1,2114 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ Error
+
-
+
- + UnexpectedPeerError + +
+
Index
+Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional message: undefined | string
+
+
Returns UnexpectedPeerError
+
+ -
+
Properties
+code
+ + +message
+ + +name
+ + +Optional stack
+ + +Static Error
+ + +Accessors
+Static code
+-
+
+
-
+
-
+
+
Returns string
+
+
+
+
+
+
+ Class PubsubBaseProtocol
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_pubsub_peer_streams_.peerstreams.html b/classes/_pubsub_peer_streams_.peerstreams.html
new file mode 100644
index 0000000..fe070ee
--- /dev/null
+++ b/classes/_pubsub_peer_streams_.peerstreams.html
@@ -0,0 +1,1207 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Buffer
+ Re-exports BufferList
+
+
+
+
+
+
+ In
+ Re-exports InMessage
+
+
+
+
+
+
+ Muxed
+ Re-exports MuxedStream
+
+
+
+ Peer
+ Re-exports PeerId
+
+
+
+
+
+
+
+
+
+ RPCSub
+ Re-exports RPCSubOpts
+
+
+
+ Signature
+ Re-exports SignaturePolicy
+
+
+
+ Signature
+ Re-exports SignaturePolicyType
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ _registrar
+
+
+
+
+
+ can
+
+
+
+
+
+ emit
+
+
+
+
+
+ global
+
+
+
+
+
+
+
+
+
+
+
+ peer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ topic
+
+
+
+
+
+
+
+
+ Static default
+
+
+
+
+
+ Static Readonly error
+
+
+
+
+
+
+
+ _accept
+
+
+
+ Protected _add
+
+
+
+ Protected _build
+
+
+
+ _decode
+
+
+
+ _emit
+
+
+
+ _encode
+
+
+
+ Protected _on
+
+
+
+ Protected _on
+
+
+
+ Protected _on
+
+
+
+ _process
+
+
+
+ _process
+
+
+
+ _process
+
+
+
+ _process
+
+
+
+
+
+
+ Protected _remove
+
+
+
+ _send
+
+
+
+ _send
+
+
+
+ add
+
+
+
+
+
+
+ event
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ listener
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ prepend
+
+
+
+ prepend
+
+
+
+
+
+
+ raw
+
+
+
+ remove
+
+
+
+ remove
+
+
+
+ set
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Static listener
+
+
+
+
+
+
+
+
+ PubsubBaseProtocol handles the peers and connections logic for pubsub routers + and specifies the API that pubsub routers should have.
+Hierarchy
+-
+
-
+ EventEmitter
+
-
+
- + PubsubBaseProtocol + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- Buffer
List
+ - Connection +
- In
Message
+ - Libp2p +
- Muxed
Stream
+ - Peer
Id
+ - RPC +
- RPCMessage +
- RPCSub
Opts
+ - Signature
Policy
+ - Signature
Policy Type
+ - message +
- utils +
Constructors
+-
+
- constructor +
Properties
+-
+
- _libp2p +
- _registrar
Id
+ - can
Relay Message
+ - emit
Self
+ - global
Signature Policy
+ - log +
- multicodecs +
- peer
Id
+ - peers +
- registrar +
- started +
- subscriptions +
- topic
Validators
+ - topics +
- default
Max Listeners
+ - error
Monitor
+
Methods
+-
+
- _accept
From
+ - _add
Peer
+ - _build
Message
+ - _decode
Rpc
+ - _emit
Message
+ - _encode
Rpc
+ - _on
Incoming Stream
+ - _on
Peer Connected
+ - _on
Peer Disconnected
+ - _process
Messages
+ - _process
Rpc
+ - _process
Rpc Message
+ - _process
Rpc Sub Opt
+ - _publish +
- _remove
Peer
+ - _send
Rpc
+ - _send
Subscriptions
+ - add
Listener
+ - emit +
- event
Names
+ - get
Max Listeners
+ - get
Msg Id
+ - get
Subscribers
+ - get
Topics
+ - listener
Count
+ - listeners +
- off +
- on +
- once +
- prepend
Listener
+ - prepend
Once Listener
+ - publish +
- raw
Listeners
+ - remove
All Listeners
+ - remove
Listener
+ - set
Max Listeners
+ - start +
- stop +
- subscribe +
- unsubscribe +
- validate +
- listener
Count
+
References
+BufferList
+ Re-exports BufferList
+ Connection
+ Re-exports Connection +InMessage
+ Re-exports InMessage
+ Libp2p
+ Re-exports Libp2p +MuxedStream
+ Re-exports MuxedStream
+ PeerId
+ Re-exports PeerId
+ RPC
+ Re-exports RPC +RPCMessage
+ Re-exports RPCMessage +RPCSubOpts
+ Re-exports RPCSubOpts
+ SignaturePolicy
+ Re-exports SignaturePolicy
+ SignaturePolicyType
+ Re-exports SignaturePolicyType
+ message
+ Re-exports message +utils
+ Re-exports utils +Constructors
+constructor
+-
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
__namedParameters: { canRelayMessage: undefined | false | true; debugName: string; emitSelf: undefined | false | true; globalSignaturePolicy: undefined | "StrictSign" | "StrictNoSign"; libp2p: any; multicodecs: string | string[] }
+-
+
-
+
can
+Relay Message: undefined | false | true
+ -
+
debug
+Name: string
+ -
+
emit
+Self: undefined | false | true
+ -
+
global
+Signature Policy: undefined | "StrictSign" | "StrictNoSign"
+ -
+
libp2p: any
+
+ -
+
multicodecs: string | string[]
+
+
+ -
+
Returns PubsubBaseProtocol
+
+ -
+
Properties
+_libp2p
+ + +_registrarId
+
+
+ canRelayMessage
+
+
+
+
+
+
+ If router can relay received messages, even if not subscribed
+emitSelf
+
+
+
+
+
+
+ if publish should emit to self, if subscribed
+globalSignaturePolicy
+
+
+
+
+
+
+ The signature policy to follow by default
+log
+ + +multicodecs
+ + +
+
+ peerId
+
+
+
+
+ peers
+ + +
+
+
+
+ Map of peer streams
+registrar
+ + +started
+ + +subscriptions
+ + +
+
+
+
+ List of our subscriptions
+topicValidators
+
+
+
+
+
+
+ Topic validator map
+Keyed by topic + Topic validators are functions with the following input:
+topics
+ + +
+
+
+
+ Map of topics to which peers are subscribed to
+Static defaultMaxListeners
+
+
+ Static Readonly errorMonitor
+
+
+
+
+
+
+ This symbol shall be used to install a listener for only monitoring 'error'
+ events. Listeners installed using this symbol are called before the regular
+ 'error' listeners are called.
Installing a listener using this symbol does not change the behavior once an
+ 'error' event is emitted, therefore the process will still crash if no
+ regular 'error' listener is installed.
Methods
+_acceptFrom
+ -
+
+
-
+
-
+
+ ++++ +
Whether to accept a message from a peer + Override to create a graylist
+Parameters
+-
+
-
+
id: string
+
+
Returns boolean
+
+ -
+
Protected _addPeer
+ -
+
+
-
+
-
+
+ ++++
Notifies the router that a peer has been connected
+Parameters
+-
+
-
+
peerId: PeerId
+
+ -
+
protocol: string
+
+
Returns PeerStreams
+
+ -
+
Protected _buildMessage
+ -
+
+
-
+
-
+
+ ++++
Normalizes the message and signs it, if signing is enabled. + Should be used by the routers to create the message to send.
+Parameters
+-
+
-
+
message: RPCMessage
+
+
Returns Promise<RPCMessage>
+
+ -
+
_decodeRpc
+ -
+
+
-
+
-
+
+ ++++
Decode Uint8Array into an RPC object. + This can be override to use a custom router protobuf.
+Parameters
+-
+
-
+
bytes: Uint8Array
+
+
Returns RPC
+
+ -
+
_emitMessage
+ -
+
+
-
+
-
+
+ ++++
Emit a message from a peer
+Parameters
+-
+
-
+
message: InMessage
+++
+
Returns void
+
+ -
+
_encodeRpc
+ -
+
+
-
+
-
+
+ ++++
Encode RPC object into a Uint8Array. + This can be override to use a custom router protobuf.
+Parameters
+-
+
-
+
rpc: RPC
+
+
Returns Uint8Array
+
+ -
+
Protected _onIncomingStream
+ -
+
+
-
+
-
+
+ ++++
On an inbound stream opened.
+Parameters
+-
+
-
+
__namedParameters: { connection: Connection; protocol: string; stream: MuxedStream }
+-
+
-
+
connection: Connection
+
+ -
+
protocol: string
+
+ -
+
stream: MuxedStream
+
+
+ -
+
Returns void
+
+ -
+
Protected _onPeerConnected
+ -
+
+
-
+
-
+
+ ++++
Registrar notifies an established connection with pubsub protocol.
+Parameters
+-
+
-
+
peerId: PeerId
+++remote peer-id
+
+ -
+
conn: Connection
+++connection to the peer
+
+
Returns Promise<void>
+
+ -
+
Protected _onPeerDisconnected
+ -
+
+
_processMessages
+ -
+
+
-
+
-
+
+ ++++
Responsible for processing each RPC message received by other peers.
+Parameters
+-
+
-
+
idB58Str: string
+++peer id string in base58
+
+ -
+
stream: AsyncIterable<Uint8Array | BufferList>
+++inbound stream
+
+ -
+
peerStreams: PeerStreams
+++PubSub peer
+
+
Returns Promise<void>
+
+ -
+
_processRpc
+ -
+
+
-
+
-
+
+ ++++
Handles an rpc request from a peer
+Parameters
+-
+
-
+
idB58Str: string
+
+ -
+
peerStreams: PeerStreams
+
+ -
+
rpc: RPC
+
+
Returns boolean
+
+ -
+
_processRpcMessage
+ -
+
+
-
+
-
+
+ ++++
Handles an message from a peer
+Parameters
+-
+
-
+
msg: InMessage
+
+
Returns Promise<void>
+
+ -
+
_processRpcSubOpt
+ -
+
+
-
+
-
+
+ ++++
Handles a subscription change from a peer
+Parameters
+-
+
-
+
id: string
+
+ -
+
subOpt: RPCSubOpts
+++
+
Returns void
+
+ -
+
_publish
+-
+
+
-
+
-
+
+ ++++ +
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
+Parameters
+-
+
-
+
message: InMessage
+
+
Returns Promise<void>
+
+ -
+
Protected _removePeer
+ -
+
+
-
+
-
+
+ ++++
Notifies the router that a peer has been disconnected.
+Parameters
+-
+
-
+
peerId: PeerId
+
+
Returns PeerStreams | undefined
+
+ -
+
_sendRpc
+ -
+
+
-
+
-
+
+ ++++
Send an rpc object to a peer
+Parameters
+-
+
-
+
id: string
+++peer id
+
+ -
+
rpc: RPC
+
+
Returns void
+
+ -
+
_sendSubscriptions
+ -
+
+
-
+
-
+
+ ++++
Send subscroptions to a peer
+Parameters
+-
+
-
+
id: string
+++peer id
+
+ -
+
topics: string[]
+
+ -
+
subscribe: boolean
+++set to false for unsubscriptions
+
+
Returns void
+
+ -
+
addListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
emit
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
Rest ...args: any[]
+
+
Returns boolean
+
+ -
+
eventNames
+ -
+
+
-
+
-
+
+
Returns Array<string | symbol>
+
+
getMaxListeners
+ -
+
+
-
+
-
+
+
Returns number
+
+
getMsgId
+ -
+
+
-
+
-
+
+ ++++
The default msgID implementation + Child class can override this.
+Parameters
+-
+
-
+
msg: RPCMessage
+++the message object
+
+
Returns Uint8Array
+message id as bytes
+
+ -
+
getSubscribers
+ -
+
+
-
+
-
+
+ ++++
Get a list of the peer-ids that are subscribed to one topic.
+Parameters
+-
+
-
+
topic: string
+
+
Returns Array<string>
+
+ -
+
getTopics
+ -
+
+
-
+
-
+
+ ++++ +
Get the list of topics which the peer is subscribed to.
+Returns Array<string>
+
+
listenerCount
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns number
+
+ -
+
listeners
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
off
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
on
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
once
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
prependListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
prependOnceListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
publish
+-
+
+
-
+
-
+
+ ++++ +
Publishes messages to all subscribed peers
+Parameters
+-
+
-
+
topic: string
+
+ -
+
message: Buffer
+
+
Returns Promise<void>
+
+ -
+
rawListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
removeAllListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional event: string | symbol
+
+
Returns this
+
+ -
+
removeListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
setMaxListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
n: number
+
+
Returns this
+
+ -
+
start
+-
+
+
-
+
-
+
+ ++++
Register the pubsub protocol onto the libp2p node.
+Returns void
+
+
stop
+-
+
+
-
+
-
+
+ ++++
Unregister the pubsub protocol and the streams with other peers will be closed.
+Returns void
+
+
subscribe
+-
+
+
-
+
-
+
+ ++++ +
Subscribes to a given topic.
+Parameters
+-
+
-
+
topic: string
+
+
Returns void
+
+ -
+
unsubscribe
+-
+
+
-
+
-
+
+ ++++ +
Unsubscribe from the given topic.
+Parameters
+-
+
-
+
topic: string
+
+
Returns void
+
+ -
+
validate
+-
+
+
-
+
-
+
+ ++++
Validates the given message. The signature will be checked for authenticity. + Throws an error on invalid messages
+Parameters
+-
+
-
+
message: InMessage
+
+
Returns Promise<void>
+
+ -
+
Static listenerCount
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
emitter: EventEmitter
+
+ -
+
event: string | symbol
+
+
Returns number
+
+ -
+
+
+
+
+
+ Class PeerStreams
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_topology_index_.topology.html b/classes/_topology_index_.topology.html
new file mode 100644
index 0000000..6030974
--- /dev/null
+++ b/classes/_topology_index_.topology.html
@@ -0,0 +1,600 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Muxed
+ Re-exports MuxedStream
+
+
+
+ Peer
+ Re-exports PeerId
+
+
+
+ Pushable
+ Re-exports PushableStream
+
+
+
+
+
+
+
+
+
+
+ Private _inbound
+
+
+
+
+
+ Private _raw
+
+
+
+
+
+ Private _raw
+
+
+
+
+
+
+
+
+ inbound
+
+
+
+
+
+ outbound
+
+
+
+
+
+
+
+
+ Static default
+
+
+
+
+
+ Static Readonly error
+
+
+
+
+
+
+
+ is
+
+
+
+ is
+
+
+
+
+
+ add
+
+
+
+ attach
+
+
+
+ attach
+
+
+
+
+
+
+
+
+
+ event
+
+
+
+ get
+
+
+
+ listener
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ prepend
+
+
+
+ prepend
+
+
+
+ raw
+
+
+
+ remove
+
+
+
+ remove
+
+
+
+ set
+
+
+
+
+
+
+ Static listener
+
+
+
+
+
+
+
+
+ Thin wrapper around a peer's inbound / outbound pubsub streams
+Hierarchy
+-
+
-
+ EventEmitter
+
-
+
- + PeerStreams + +
+
Index
+
+
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- Muxed
Stream
+ - Peer
Id
+ - Pushable
Stream
+
Constructors
+-
+
- constructor +
Properties
+ +Accessors
+-
+
- is
Readable
+ - is
Writable
+
Methods
+-
+
- add
Listener
+ - attach
Inbound Stream
+ - attach
Outbound Stream
+ - close +
- emit +
- event
Names
+ - get
Max Listeners
+ - listener
Count
+ - listeners +
- off +
- on +
- once +
- prepend
Listener
+ - prepend
Once Listener
+ - raw
Listeners
+ - remove
All Listeners
+ - remove
Listener
+ - set
Max Listeners
+ - write +
- listener
Count
+
References
+MuxedStream
+ Re-exports MuxedStream
+ PeerId
+ Re-exports PeerId
+ PushableStream
+ Re-exports PushableStream
+ Constructors
+constructor
+-
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
__namedParameters: { id: PeerId; protocol: string }
+-
+
-
+
id: PeerId
+
+ -
+
protocol: string
+
+
+ -
+
Returns PeerStreams
+
+ -
+
Properties
+Private _inboundAbortController
+
+
+
+
+
+
+ An AbortController for controlled shutdown of the inbound stream
+Private _rawInboundStream
+
+
+
+
+
+
+ The raw inbound stream, as retrieved from the callback from libp2p.handle
+Private _rawOutboundStream
+
+
+
+
+
+
+ The raw outbound stream, as retrieved from conn.newStream
+id
+ + +
+
+ inboundStream
+
+
+
+
+
+
+ Read stream
+outboundStream
+
+
+
+
+
+
+ Write stream -- its preferable to use the write method
+protocol
+ + +
+
+
+
+ Established protocol
+Static defaultMaxListeners
+
+
+ Static Readonly errorMonitor
+
+
+
+
+
+
+ This symbol shall be used to install a listener for only monitoring 'error'
+ events. Listeners installed using this symbol are called before the regular
+ 'error' listeners are called.
Installing a listener using this symbol does not change the behavior once an
+ 'error' event is emitted, therefore the process will still crash if no
+ regular 'error' listener is installed.
Accessors
+isReadable
+ -
+
+
-
+
-
+
+ ++++
Do we have a connection to read from?
+Returns boolean
+
+
isWritable
+ -
+
+
-
+
-
+
+ ++++
Do we have a connection to write on?
+Returns boolean
+
+
Methods
+addListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
attachInboundStream
+ -
+
+
-
+
-
+
+ ++++
Attach a raw inbound stream and setup a read stream
+Parameters
+-
+
-
+
stream: MuxedStream
+
+
Returns AsyncIterable<Uint8Array>
+
+ -
+
attachOutboundStream
+ -
+
+
-
+
-
+
+ ++++
Attach a raw outbound stream and setup a write stream
+Parameters
+-
+
-
+
stream: MuxedStream
+
+
Returns Promise<void>
+
+ -
+
close
+-
+
+
-
+
-
+
+ ++++
Closes the open connection to peer
+Returns void
+
+
emit
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
Rest ...args: any[]
+
+
Returns boolean
+
+ -
+
eventNames
+ -
+
+
-
+
-
+
+
Returns Array<string | symbol>
+
+
getMaxListeners
+ -
+
+
-
+
-
+
+
Returns number
+
+
listenerCount
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns number
+
+ -
+
listeners
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
off
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
on
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
once
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
prependListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
prependOnceListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
rawListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
removeAllListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional event: string | symbol
+
+
Returns this
+
+ -
+
removeListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
setMaxListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
n: number
+
+
Returns this
+
+ -
+
write
+-
+
+
-
+
-
+
+ ++++
Send a message to this peer. + Throws if there is no
+streamto write to available.Parameters
+-
+
-
+
data: Uint8Array
+
+
Returns void
+
+ -
+
Static listenerCount
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
emitter: EventEmitter
+
+ -
+
event: string | symbol
+
+
Returns number
+
+ -
+
+
+
+
+
+ Class Topology
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_topology_multicodec_topology_.multicodectopology.html b/classes/_topology_multicodec_topology_.multicodectopology.html
new file mode 100644
index 0000000..9e019ef
--- /dev/null
+++ b/classes/_topology_multicodec_topology_.multicodectopology.html
@@ -0,0 +1,795 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Peer
+ Re-exports PeerId
+
+
+
+
+
+
+
+
+
+
+ _on
+
+
+
+
+
+ _on
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ [
+
+
+
+
+
+
+
+
+
+
+
+ Static is
+
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ Topology
+
-
+
- + MulticodecTopology + +
+
Index
+
+
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- Connection +
- Handlers +
- Options +
- Peer
Id
+
Constructors
+-
+
- constructor +
Properties
+-
+
- _on
Connect
+ - _on
Disconnect
+ - _registrar +
- max +
- min +
- peers +
Accessors
+ +Methods
+-
+
- disconnect +
- is
Topology
+
References
+Connection
+ Re-exports Connection +Handlers
+ Re-exports Handlers +Options
+ Re-exports Options +PeerId
+ Re-exports PeerId
+ Constructors
+constructor
+-
+
+
Properties
+_onConnect
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
peerId: PeerId
+
+ -
+
conn: Connection
+
+
Returns void
+
+ -
+
+ -
+
_onDisconnect
+
+
+
+ _registrar
+ + +max
+ + +min
+ + +peers
+ + +
+
+
+
+ Set of peers that support the protocol.
+Accessors
+[Symbol.toStringTag]
+ -
+
+
-
+
-
+
+
Returns string
+
+
registrar
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
arg: any
+
+
Returns any
+
+ -
+
Methods
+disconnect
+-
+
+
-
+
-
+
+ ++++
Notify about peer disconnected event.
+Parameters
+-
+
-
+
peerId: PeerId
+
+
Returns void
+
+ -
+
Static isTopology
+ -
+
+
-
+
-
+
+ ++++
Checks if the given value is a Topology instance.
+Parameters
+-
+
-
+
other: any
+
+
Returns other is Topology
+
+ -
+
+
+
+
+
+ Class MulticodecTopology
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_transport_errors_.aborterror.html b/classes/_transport_errors_.aborterror.html
new file mode 100644
index 0000000..d4f4bc2
--- /dev/null
+++ b/classes/_transport_errors_.aborterror.html
@@ -0,0 +1,357 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Multicodec
+ Re-exports MulticodecOptions
+
+
+
+
+
+
+ Peer
+ Re-exports PeerId
+
+
+
+ Peer
+ Re-exports PeerId
+
+
+
+ Topology
+ Re-exports TopologyOptions
+
+
+
+
+
+
+
+
+
+
+ _on
+
+
+
+
+
+ _on
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ [
+
+
+
+
+
+
+
+
+ _on
+
+
+
+ _on
+
+
+
+ _update
+
+
+
+
+
+
+ Static is
+
+
+
+ Static is
+
+
+
+
+ Hierarchy
+-
+
-
+ Topology
+
-
+
- + MulticodecTopology + +
+
Index
+
+
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- Connection +
- Connection +
- Handlers +
- Handlers +
- Multiaddr +
- Multicodec
Options
+ - Options +
- Peer
Id
+ - Peer
Id
+ - Topology
Options
+
Constructors
+-
+
- constructor +
Properties
+-
+
- _on
Connect
+ - _on
Disconnect
+ - _registrar +
- max +
- min +
- multicodecs +
- peers +
Accessors
+ +Methods
+ +References
+Connection
+ Re-exports Connection +Connection
+ Re-exports Connection +Handlers
+ Re-exports Handlers +Handlers
+ Re-exports Handlers +Multiaddr
+ Re-exports Multiaddr +MulticodecOptions
+ Re-exports MulticodecOptions
+ Options
+ Re-exports Options +PeerId
+ Re-exports PeerId
+ PeerId
+ Re-exports PeerId
+ TopologyOptions
+ Re-exports TopologyOptions
+ Constructors
+constructor
+-
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
__namedParameters: { handlers: Handlers & Required<Handlers>; max: undefined | number; min: undefined | number; multicodecs: string[] }
+ +
+
Returns MulticodecTopology
+
+ -
+
Properties
+_onConnect
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
peerId: PeerId
+
+ -
+
conn: Connection
+
+
Returns void
+
+ -
+
+ -
+
_onDisconnect
+
+
+
+ _registrar
+ + +max
+ + +min
+ + +multicodecs
+ + +peers
+ + +
+
+
+
+ Set of peers that support the protocol.
+Accessors
+[Symbol.toStringTag]
+ -
+
+
-
+
-
+
+
Returns string
+
+
registrar
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
arg: any
+
+
Returns any
+
+ -
+
Methods
+_onPeerConnect
+ -
+
+
-
+
-
+
+ ++++
Verify if a new connected peer has a topology multicodec and call _onConnect.
+Parameters
+-
+
-
+
connection: Connection
+
+
Returns void
+
+ -
+
_onProtocolChange
+ -
+
+
_updatePeers
+ -
+
+
disconnect
+-
+
+
-
+
-
+
+ ++++
Notify about peer disconnected event.
+Parameters
+-
+
-
+
peerId: PeerId
+
+
Returns void
+
+ -
+
Static isMulticodecTopology
+ -
+
+
-
+
-
+
+ ++++
Checks if the given value is a
+MulticodecTopologyinstance.Parameters
+-
+
-
+
other: any
+
+
Returns other is MulticodecTopology
+
+ -
+
Static isTopology
+ -
+
+
-
+
-
+
+ ++++
Checks if the given value is a Topology instance.
+Parameters
+-
+
-
+
other: any
+
+
Returns other is Topology
+
+ -
+
+
+
+
+
+ Class AbortError
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/globals.html b/globals.html
new file mode 100644
index 0000000..a04fcfc
Binary files /dev/null and b/globals.html differ
diff --git a/index.html b/index.html
index 23b04e3..22ea1b7 100644
--- a/index.html
+++ b/index.html
@@ -1,45 +1,389 @@
-
+
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ Error
+
-
+
- + AbortError + +
+
Index
+Properties
+code
+ + +message
+ + +name
+ + +Optional stack
+ + +type
+ + +Static Error
+ + +Accessors
+Static code
+-
+
+
-
+
-
+
+
Returns string
+
+
Static type
+-
+
+
-
+
-
+
+
Returns string
+
+
-
-
-
-
-
-
+
+
+
+
+
+
+ libp2p-interfaces - v0.8.0
+
+
+
+
+
-
+
\ No newline at end of file
diff --git a/interfaces/_crypto_types_.crypto.html b/interfaces/_crypto_types_.crypto.html
new file mode 100644
index 0000000..5455181
--- /dev/null
+++ b/interfaces/_crypto_types_.crypto.html
@@ -0,0 +1,334 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+ JS libp2p Interfaces
+ +
+ 
+ 
+ 
++ +Contains test suites and interfaces you can use to implement the various components of libp2p.
+
Lead Maintainer
+ + + +Interfaces
+ +-
+
- Connection +
- Content Routing +
- Crypto +
- Peer Discovery +
- Peer Routing +
- Pubsub +
- Record +
- Stream Muxer +
- Topology +
- Transport +
Origin Repositories
+ +For posterity, here are links to the original repositories for each of the interfaces (if they had one).
+-
+
- Connection +
- Content Routing +
- Peer Discovery +
- Peer Routing +
- Pubsub +
- Stream Muxer +
- Transport +
Contribute
+ +Feel free to join in. All welcome. Open an issue!
+This repository falls under the IPFS Code of Conduct.
+
License
+ +MIT - Protocol Labs 2019
+
+
+
+
+
+ Interface Crypto
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/_record_types_.record.html b/interfaces/_record_types_.record.html
new file mode 100644
index 0000000..1f77f31
--- /dev/null
+++ b/interfaces/_record_types_.record.html
@@ -0,0 +1,333 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ secure
+
+
+
+ secure
+
+
+
+
+
+
+
+
+ A libp2p crypto module must be compliant to this interface + to ensure all exchanged data between two peers is encrypted.
+Hierarchy
+-
+
- + Crypto + +
Index
+
+
+
+
+
+
+ Properties
+-
+
- protocol +
Methods
+-
+
- secure
Inbound
+ - secure
Outbound
+
Properties
+protocol
+ + +Methods
+secureInbound
+ -
+
+
-
+
-
+
+ ++++
Decrypt incoming data.
+Parameters
+-
+
-
+
localPeer: PeerId
+
+ -
+
connection: MultiaddrConnection
+
+ -
+
Optional remotePeer: PeerId
+
+
Returns Promise<SecureOutbound>
+
+ -
+
secureOutbound
+ -
+
+
-
+
-
+
+ ++++
Encrypt outgoing data to the remote party.
+Parameters
+-
+
-
+
localPeer: PeerId
+
+ -
+
connection: MultiaddrConnection
+
+ -
+
remotePeer: PeerId
+
+
Returns Promise<SecureOutbound>
+
+ -
+
+
+
+
+
+ Interface Record
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/_stream_muxer_types_.muxedstream.html b/interfaces/_stream_muxer_types_.muxedstream.html
new file mode 100644
index 0000000..1cda725
--- /dev/null
+++ b/interfaces/_stream_muxer_types_.muxedstream.html
@@ -0,0 +1,417 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Record is the base implementation of a record that can be used as the payload of a libp2p envelope.
+Hierarchy
+-
+
- + Record + +
Index
+Properties
+codec
+ + +
+
+
+
+ identifier of the type of record
+domain
+ + +
+
+
+
+ signature domain.
+Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Verifies if the other provided Record is identical to this one.
+Parameters
+-
+
-
+
other: unknown
+
+
Returns boolean
+
+ -
+
marshal
+-
+
+
-
+
-
+
+ ++++
Marshal a record to be used in an envelope.
+Returns Uint8Array
+
+
+
+
+
+
+ Interface MuxedStream
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/_stream_muxer_types_.muxer.html b/interfaces/_stream_muxer_types_.muxer.html
new file mode 100644
index 0000000..3159649
--- /dev/null
+++ b/interfaces/_stream_muxer_types_.muxer.html
@@ -0,0 +1,363 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ [
+
+
+
+
+ Hierarchy
+-
+
-
+ AsyncIterable<Uint8Array | BufferList>
+
-
+
- + MuxedStream + +
+
Index
+Properties
+abort
+ + +
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
close
+ + +
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
id
+ + +reset
+ + +
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
sink
+ + +source
+ + +
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Returns AsyncIterable<Uint8Array | BufferList>
+
+
+ -
+
timeline
+ + +Methods
+[Symbol.asyncIterator]
+ -
+
+
-
+
-
+
+
Returns AsyncIterator<Uint8Array | BufferList>
+
+
+
+
+
+
+ Interface Muxer
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/_stream_muxer_types_.muxerfactory.html b/interfaces/_stream_muxer_types_.muxerfactory.html
new file mode 100644
index 0000000..9d49062
--- /dev/null
+++ b/interfaces/_stream_muxer_types_.muxerfactory.html
@@ -0,0 +1,292 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ new
+
+
+
+ on
+
+
+
+ on
+
+
+
+
+
+
+
+
+ A libp2p stream muxer
+Hierarchy
+-
+
- + Muxer + +
Index
+
+
+
+
+
+
+ Properties
+-
+
- streams +
Methods
+-
+
- new
Stream
+ - on
Stream
+ - on
Stream End
+
Properties
+Readonly streams
+ + +Methods
+newStream
+ -
+
+
-
+
-
+
+ ++++
Initiate a new stream with the given name. If no name is + provided, the id of th stream will be used.
+Parameters
+-
+
-
+
Optional name: undefined | string
+
+
Returns MuxedStream
+
+ -
+
onStream
+ -
+
+
-
+
-
+
+ ++++
A function called when receiving a new stream from the remote.
+Parameters
+-
+
-
+
stream: MuxedStream
+
+
Returns void
+
+ -
+
onStreamEnd
+ -
+
+
-
+
-
+
+ ++++
A function called when a stream ends.
+Parameters
+-
+
-
+
stream: MuxedStream
+
+
Returns void
+
+ -
+
+
+
+
+
+ Interface MuxerFactory
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/_transport_types_.listener.html b/interfaces/_transport_types_.listener.html
new file mode 100644
index 0000000..a2ee416
--- /dev/null
+++ b/interfaces/_transport_types_.listener.html
@@ -0,0 +1,951 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + MuxerFactory + +
Index
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- multicodec +
Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
options: MuxerOptions
+
+
Returns Muxer
+
+ -
+
Properties
+multicodec
+ + +
+
+
+
+
+ Interface Listener
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/_transport_types_.transport.html b/interfaces/_transport_types_.transport.html
new file mode 100644
index 0000000..e17831c
--- /dev/null
+++ b/interfaces/_transport_types_.transport.html
@@ -0,0 +1,359 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Static default
+
+
+
+
+
+ Static Readonly error
+
+
+
+
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+ event
+
+
+
+ get
+
+
+
+ get
+
+
+
+
+
+
+ listener
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ prepend
+
+
+
+ prepend
+
+
+
+ raw
+
+
+
+ remove
+
+
+
+ remove
+
+
+
+ set
+
+
+
+ Static listener
+
+
+
+
+ Hierarchy
+-
+
-
+ EventEmitter
+
-
+
- + Listener + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+ +Methods
+-
+
- add
Listener
+ - close +
- emit +
- event
Names
+ - get
Addrs
+ - get
Max Listeners
+ - listen +
- listener
Count
+ - listeners +
- off +
- on +
- once +
- prepend
Listener
+ - prepend
Once Listener
+ - raw
Listeners
+ - remove
All Listeners
+ - remove
Listener
+ - set
Max Listeners
+ - listener
Count
+
Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional options: EventEmitterOptions
+
+
Returns Listener
+
+ -
+
Properties
+Static defaultMaxListeners
+
+
+ Static Readonly errorMonitor
+
+
+
+
+
+
+ This symbol shall be used to install a listener for only monitoring 'error'
+ events. Listeners installed using this symbol are called before the regular
+ 'error' listeners are called.
Installing a listener using this symbol does not change the behavior once an
+ 'error' event is emitted, therefore the process will still crash if no
+ regular 'error' listener is installed.
Methods
+addListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
close
+-
+
+
-
+
-
+
+ ++++
Close listener
+Returns Promise<void>
+
+
emit
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
Rest ...args: any[]
+
+
Returns boolean
+
+ -
+
eventNames
+ -
+
+
-
+
-
+
+
Returns Array<string | symbol>
+
+
getAddrs
+ -
+
+
-
+
-
+
+ ++++
Get listen addresses
+Returns Multiaddr[]
+
+
getMaxListeners
+ -
+
+
-
+
-
+
+
Returns number
+
+
listen
+-
+
+
-
+
-
+
+ ++++
Start a listener
+Parameters
+-
+
-
+
multiaddr: Multiaddr
+
+
Returns Promise<void>
+
+ -
+
listenerCount
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns number
+
+ -
+
listeners
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
off
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
on
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
once
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
prependListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
prependOnceListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
rawListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
removeAllListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional event: string | symbol
+
+
Returns this
+
+ -
+
removeListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
setMaxListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
n: number
+
+
Returns this
+
+ -
+
Static listenerCount
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
emitter: EventEmitter
+
+ -
+
event: string | symbol
+
+
Returns number
+
+ -
+
+
+
+
+
+ Interface Transport<DialOptions, ListenerOptions>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/_transport_types_.transportfactory.html b/interfaces/_transport_types_.transportfactory.html
new file mode 100644
index 0000000..8cfc54c
--- /dev/null
+++ b/interfaces/_transport_types_.transportfactory.html
@@ -0,0 +1,283 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ create
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A libp2p transport is understood as something that offers a dial and listen interface to establish connections.
+Type parameters
+-
+
-
+
DialOptions: { signal?: AbortSignal }
+
+ -
+
ListenerOptions
+
+
Hierarchy
+-
+
- + Transport + +
Index
+
+
+
+
+ Methods
+-
+
- create
Listener
+ - dial +
- filter +
Methods
+createListener
+ -
+
+
-
+
-
+
+ ++++
Create transport listeners.
+Parameters
+-
+
-
+
options: ListenerOptions
+
+ -
+
Optional handler: undefined | ((connection: Connection) => void)
+
+
Returns Listener
+
+ -
+
dial
+-
+
+
-
+
-
+
+ ++++
Dial a given multiaddr.
+Parameters
+-
+
-
+
ma: Multiaddr
+
+ -
+
Optional options: DialOptions
+
+
Returns Promise<Connection>
+
+ -
+
filter
+-
+
+
+
+
+
+
+ Interface TransportFactory<DialOptions, ListenerOptions>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/interfaces/_transport_types_.upgrader.html b/interfaces/_transport_types_.upgrader.html
new file mode 100644
index 0000000..5f7b55b
--- /dev/null
+++ b/interfaces/_transport_types_.upgrader.html
@@ -0,0 +1,306 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type parameters
+-
+
-
+
DialOptions: { signal?: AbortSignal }
+
+ -
+
ListenerOptions
+
+
Hierarchy
+-
+
- + TransportFactory + +
Index
+
+
+
+
+ Constructors
+-
+
- constructor +
Constructors
+constructor
+-
+
+
+
+
+
+
+ Interface Upgrader
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/__libp2p_interfaces_.html b/modules/__libp2p_interfaces_.html
new file mode 100644
index 0000000..80d0d4f
Binary files /dev/null and b/modules/__libp2p_interfaces_.html differ
diff --git a/modules/_connection_connection_.html b/modules/_connection_connection_.html
new file mode 100644
index 0000000..7c3f858
--- /dev/null
+++ b/modules/_connection_connection_.html
@@ -0,0 +1,512 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ upgrade
+
+
+
+ upgrade
+
+
+
+
+ Hierarchy
+-
+
- + Upgrader + +
Index
+
+
+
+
+ Methods
+ +Methods
+upgradeInbound
+ -
+
+
-
+
-
+
+ ++++
Upgrades an inbound connection on transport listener.
+Parameters
+-
+
-
+
maConn: MultiaddrConnection
+
+
Returns Promise<Connection>
+
+ -
+
upgradeOutbound
+ -
+
+
-
+
-
+
+ ++++
Upgrades an outbound connection on
+transport.dial.Parameters
+-
+
-
+
maConn: MultiaddrConnection
+
+
Returns Promise<Connection>
+
+ -
+
+
+
+
+
+ Module connection/connection
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_connection_index_.html b/modules/_connection_index_.html
new file mode 100644
index 0000000..1a23c76
--- /dev/null
+++ b/modules/_connection_index_.html
@@ -0,0 +1,223 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Conection
+
+
+
+
+
+ Connection
+
+
+
+
+
+ Muxed
+
+
+
+
+
+
+
+
+ Stream
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Classes
+-
+
- Connection +
Type aliases
+-
+
- Conection
Stat
+ - Connection
Options
+ - Muxed
Stream
+ - Status +
- Stream
Data
+ - Timeline +
Type aliases
+ConectionStat
+
+
+
+
+ Type declaration
+-
+
-
+
direction: string
+++++-
+
- connection establishment direction ("inbound" or "outbound"). +
+ -
+
Optional encryption?: string | undefined
+++++-
+
- connection encryption method identifier. +
+ -
+
Optional multiplexer?: string | undefined
+++++-
+
- connection multiplexing identifier. +
+ -
+
timeline: Timeline
+++++-
+
- connection relevant events timestamp. +
+
ConnectionOptions
+
+
+
+
+ Type declaration
+-
+
-
+
close: () => Promise<void>
+++++-
+
- close raw connection function. +
-
+
-
+
-
+
+
-
+
-
+
Returns Promise<void>
+
+
+ -
+
+ -
+
get
+Streams: () => MuxedStream[] ++++-
+
- get streams from muxer function. +
-
+
-
+
-
+
+
-
+
-
+
Returns MuxedStream[]
+
+
+ -
+
+ -
+
Optional local
+Addr?: Multiaddr | undefined ++++-
+
- local multiaddr of the connection if known. +
+ -
+
local
+Peer: PeerId ++++-
+
- local peer-id. +
+ -
+
new
+Stream: (protocols: string | string[]) => Promise<{ protocol: string; stream: MuxedStream }> ++++-
+
- new stream muxer function. +
-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
protocols: string | string[]
+
+
Returns Promise<{ protocol: string; stream: MuxedStream }>
+
+ -
+
+ -
+
+ -
+
remote
+Addr: Multiaddr ++++-
+
- remote multiaddr of the connection. +
+ -
+
remote
+Peer: PeerId ++++-
+
- remote peer-id. +
+ -
+
stat: ConectionStat
+++++-
+
- metadata of the connection. +
+
MuxedStream
+
+
+ Status
+ + +StreamData
+
+
+
+
+ Type declaration
+-
+
-
+
Optional metadata?: any
+++++-
+
- metadata of the stream +
+ -
+
protocol: string
+++++-
+
- the protocol used by the stream +
+
Timeline
+ + +
+
+ Type declaration
+-
+
-
+
Optional close?: number | undefined
+
+ -
+
open: number
+++++-
+
- connection opening timestamp. +
+ -
+
Optional upgraded?: number | undefined
+++++-
+
- connection upgraded timestamp. +
+
+
+
+
+
+ Module connection/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_connection_status_.html b/modules/_connection_status_.html
new file mode 100644
index 0000000..45d536e
--- /dev/null
+++ b/modules/_connection_status_.html
@@ -0,0 +1,223 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Variables
+-
+
- Connection +
Variables
+Connection
+ + +
+
+
+
+
+ Module connection/status
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_connection_tests_connection_.html b/modules/_connection_tests_connection_.html
new file mode 100644
index 0000000..dbfaa71
--- /dev/null
+++ b/modules/_connection_tests_connection_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Type aliases
+-
+
- Status +
Type aliases
+Status
+ + +
+
+
+
+
+ Module connection/tests/connection
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_connection_tests_index_.html b/modules/_connection_tests_index_.html
new file mode 100644
index 0000000..4384709
--- /dev/null
+++ b/modules/_connection_tests_index_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+Export assignment _exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
test: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module connection/tests/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_content_routing_types_.html b/modules/_content_routing_types_.html
new file mode 100644
index 0000000..2267819
--- /dev/null
+++ b/modules/_content_routing_types_.html
@@ -0,0 +1,197 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
test: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module content-routing/types
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_crypto_errors_.html b/modules/_crypto_errors_.html
new file mode 100644
index 0000000..112a008
--- /dev/null
+++ b/modules/_crypto_errors_.html
@@ -0,0 +1,221 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Module crypto/errors
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_crypto_tests_index_.html b/modules/_crypto_tests_index_.html
new file mode 100644
index 0000000..26be4f9
--- /dev/null
+++ b/modules/_crypto_tests_index_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Classes
+ +
+
+
+
+
+ Module crypto/tests/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_crypto_types_.html b/modules/_crypto_types_.html
new file mode 100644
index 0000000..6a6619e
--- /dev/null
+++ b/modules/_crypto_types_.html
@@ -0,0 +1,246 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
common: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module crypto/types
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_peer_discovery_tests_index_.html b/modules/_peer_discovery_tests_index_.html
new file mode 100644
index 0000000..66a32f8
--- /dev/null
+++ b/modules/_peer_discovery_tests_index_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Secure
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Interfaces
+-
+
- Crypto +
Type aliases
+-
+
- Secure
Outbound
+
Type aliases
+SecureOutbound
+
+
+
+
+ Type declaration
+-
+
-
+
conn: MultiaddrConnection
+
+ -
+
remote
+Early Data: Buffer
+ -
+
remote
+Peer: PeerId
+
+
+
+
+
+ Module peer-discovery/tests/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pubsub_errors_.codes.html b/modules/_pubsub_errors_.codes.html
new file mode 100644
index 0000000..4459378
--- /dev/null
+++ b/modules/_pubsub_errors_.codes.html
@@ -0,0 +1,319 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
common: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Namespace codes
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pubsub_errors_.html b/modules/_pubsub_errors_.html
new file mode 100644
index 0000000..966705f
--- /dev/null
+++ b/modules/_pubsub_errors_.html
@@ -0,0 +1,215 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+
+ Index
+Variables
+Const ERR_INVALID_SIGNATURE
+
+
+ Const ERR_INVALID_SIGNATURE_POLICY
+
+
+ Const ERR_MISSING_SEQNO
+
+
+ Const ERR_MISSING_SIGNATURE
+
+
+ Const ERR_UNEXPECTED_FROM
+
+
+ Const ERR_UNEXPECTED_KEY
+
+
+ Const ERR_UNEXPECTED_SEQNO
+
+
+ Const ERR_UNEXPECTED_SIGNATURE
+
+
+ Const ERR_UNHANDLED_SIGNATURE_POLICY
+
+
+
+
+
+
+
+ Module pubsub/errors
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pubsub_index_.html b/modules/_pubsub_index_.html
new file mode 100644
index 0000000..0f77143
--- /dev/null
+++ b/modules/_pubsub_index_.html
@@ -0,0 +1,422 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Namespaces
+-
+
- codes +
+
+
+
+
+ Module pubsub/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pubsub_message_index_.html b/modules/_pubsub_message_index_.html
new file mode 100644
index 0000000..510e562
--- /dev/null
+++ b/modules/_pubsub_message_index_.html
@@ -0,0 +1,267 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Buffer
+
+
+
+
+
+
+
+
+ In
+
+
+
+
+
+
+
+
+ Muxed
+
+
+
+
+
+ Peer
+
+
+
+
+
+
+
+
+
+
+
+ RPCSub
+
+
+
+
+
+ Signature
+
+
+
+
+
+
+
+ Const Pubsub
+
+
+
+
+
+ Const Signature
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+
+
+ Classes
+ +Type aliases
+-
+
- Buffer
List
+ - Connection +
- In
Message
+ - Libp2p +
- Muxed
Stream
+ - Peer
Id
+ - RPC +
- RPCMessage +
- RPCSub
Opts
+ - Signature
Policy Type
+
Variables
+-
+
- Pubsub
Base Protocol_ base
+ - Signature
Policy
+ - message +
- utils +
Type aliases
+BufferList
+
+
+ Connection
+ + +InMessage
+
+
+
+
+ Type declaration
+-
+
-
+
data: Uint8Array
+
+ -
+
Optional from?: string | undefined
+
+ -
+
Optional key?: Uint8Array | undefined
+
+ -
+
received
+From: string
+ -
+
Optional seqno?: Uint8Array | undefined
+
+ -
+
Optional signature?: Uint8Array | undefined
+
+ -
+
topicIDs: string[]
+
+
Libp2p
+ + +MuxedStream
+
+
+ PeerId
+
+
+ RPC
+ + +RPCMessage
+ + +RPCSubOpts
+
+
+ SignaturePolicyType
+
+
+ Variables
+Const PubsubBaseProtocol_base
+
+
+ Const SignaturePolicy
+
+
+
+
+ Type declaration
+-
+
-
+
Strict
+NoSign: "StrictNoSign"
+ -
+
Strict
+Sign: "StrictSign"
+
Const message
+ + +
+
+ Const utils
+ + +
+
+
+
+
+ Module pubsub/message/index
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pubsub_message_rpc_proto_.html b/modules/_pubsub_message_rpc_proto_.html
new file mode 100644
index 0000000..d42c0be
--- /dev/null
+++ b/modules/_pubsub_message_rpc_proto_.html
@@ -0,0 +1,223 @@
+
+
+
+
+
+
+
+
+
+
+ Module pubsub/message/rpc.proto
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pubsub_message_sign_.html b/modules/_pubsub_message_sign_.html
new file mode 100644
index 0000000..71020a4
--- /dev/null
+++ b/modules/_pubsub_message_sign_.html
@@ -0,0 +1,378 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Variables
+-
+
- _exports +
Variables
+Const _exports
+ + +
+
+
+
+
+ Module pubsub/message/sign
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pubsub_message_topic_descriptor_proto_.html b/modules/_pubsub_message_topic_descriptor_proto_.html
new file mode 100644
index 0000000..0c5cb82
--- /dev/null
+++ b/modules/_pubsub_message_topic_descriptor_proto_.html
@@ -0,0 +1,223 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ In
+
+
+
+
+
+ Public
+
+
+
+
+
+
+
+ Const Sign
+
+
+
+
+
+
+
+ message
+
+
+
+ sign
+
+
+
+ verify
+
+
+
+
+ Index
+Type aliases
+InMessage
+
+
+
+
+ Type declaration
+-
+
-
+
data: Uint8Array
+
+ -
+
Optional from?: string | undefined
+
+ -
+
Optional key?: Uint8Array | undefined
+
+ -
+
received
+From: string
+ -
+
Optional seqno?: Uint8Array | undefined
+
+ -
+
Optional signature?: Uint8Array | undefined
+
+ -
+
topicIDs: string[]
+
+
PublicKey
+
+
+ Variables
+Const SignPrefix
+
+
+ Functions
+messagePublicKey
+ -
+
+
-
+
-
+
+ ++++
Returns the PublicKey associated with the given message. + If no, valid PublicKey can be retrieved an error will be returned.
+Parameters
+-
+
-
+
message: InMessage
+
+
Returns Promise<PublicKey>
+
+ -
+
signMessage
+ -
+
+
-
+
-
+
+ ++++
Signs the provided message with the given
+peerIdParameters
+-
+
-
+
peerId: PeerId
+
+ -
+
message: any
+
+
Returns Promise<any>
+
+ -
+
verifySignature
+ -
+
+
-
+
-
+
+ ++++
Verifies the signature of the given message
+Parameters
+-
+
-
+
message: InMessage
+
+
Returns Promise<boolean>
+
+ -
+
+
+
+
+
+ Module pubsub/message/topic-descriptor.proto
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pubsub_peer_streams_.html b/modules/_pubsub_peer_streams_.html
new file mode 100644
index 0000000..6b63488
--- /dev/null
+++ b/modules/_pubsub_peer_streams_.html
@@ -0,0 +1,273 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Variables
+-
+
- _exports +
Variables
+Const _exports
+ + +
+
+
+
+
+ Module pubsub/peer-streams
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pubsub_signature_policy_.html b/modules/_pubsub_signature_policy_.html
new file mode 100644
index 0000000..da03497
--- /dev/null
+++ b/modules/_pubsub_signature_policy_.html
@@ -0,0 +1,234 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Muxed
+
+
+
+
+
+ Peer
+
+
+
+
+
+ Pushable
+
+
+
+
+
+
+
+ Const Peer
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+
+
+ Classes
+-
+
- Peer
Streams
+
Type aliases
+-
+
- Muxed
Stream
+ - Peer
Id
+ - Pushable
Stream
+
Variables
+-
+
- Peer
Streams_ base
+
Type aliases
+MuxedStream
+
+
+ PeerId
+
+
+ PushableStream
+
+
+ Variables
+Const PeerStreams_base
+
+
+
+
+
+
+
+ Module pubsub/signature-policy
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pubsub_signature_policy_.signaturepolicy.html b/modules/_pubsub_signature_policy_.signaturepolicy.html
new file mode 100644
index 0000000..6d292bc
--- /dev/null
+++ b/modules/_pubsub_signature_policy_.signaturepolicy.html
@@ -0,0 +1,242 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Signature
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Namespaces
+-
+
- Signature
Policy
+
Type aliases
+ +Type aliases
+SignaturePolicyType
+
+
+
+
+
+
+
+ Namespace SignaturePolicy
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pubsub_tests_api_.html b/modules/_pubsub_tests_api_.html
new file mode 100644
index 0000000..baff329
--- /dev/null
+++ b/modules/_pubsub_tests_api_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Const Strict
+
+
+
+
+
+ Const Strict
+
+
+
+
+
+
+ Index
+
+
+
+
+ Variables
+-
+
- Strict
NoSign
+ - Strict
Sign
+
Variables
+Const StrictNoSign
+
+
+ Const StrictSign
+
+
+
+
+
+
+
+ Module pubsub/tests/api
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pubsub_tests_emit_self_.html b/modules/_pubsub_tests_emit_self_.html
new file mode 100644
index 0000000..c4b7798
--- /dev/null
+++ b/modules/_pubsub_tests_emit_self_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
common: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module pubsub/tests/emit-self
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pubsub_tests_index_.html b/modules/_pubsub_tests_index_.html
new file mode 100644
index 0000000..8cb6e53
--- /dev/null
+++ b/modules/_pubsub_tests_index_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
common: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module pubsub/tests/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pubsub_tests_messages_.html b/modules/_pubsub_tests_messages_.html
new file mode 100644
index 0000000..0b5dbc1
--- /dev/null
+++ b/modules/_pubsub_tests_messages_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
common: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module pubsub/tests/messages
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pubsub_tests_multiple_nodes_.html b/modules/_pubsub_tests_multiple_nodes_.html
new file mode 100644
index 0000000..172e5dc
--- /dev/null
+++ b/modules/_pubsub_tests_multiple_nodes_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
common: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module pubsub/tests/multiple-nodes
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pubsub_tests_two_nodes_.html b/modules/_pubsub_tests_two_nodes_.html
new file mode 100644
index 0000000..f710011
--- /dev/null
+++ b/modules/_pubsub_tests_two_nodes_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
common: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module pubsub/tests/two-nodes
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pubsub_tests_utils_.html b/modules/_pubsub_tests_utils_.html
new file mode 100644
index 0000000..47c26d6
--- /dev/null
+++ b/modules/_pubsub_tests_utils_.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
common: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module pubsub/tests/utils
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pubsub_utils_.html b/modules/_pubsub_utils_.html
new file mode 100644
index 0000000..30d8ebe
--- /dev/null
+++ b/modules/_pubsub_utils_.html
@@ -0,0 +1,401 @@
+
+
+
+
+
+
+
+
+
+
+ Module pubsub/utils
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_record_tests_index_.html b/modules/_record_tests_index_.html
new file mode 100644
index 0000000..46a4d81
--- /dev/null
+++ b/modules/_record_tests_index_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ any
+
+
+
+ ensure
+
+
+
+ msg
+
+
+
+ no
+
+
+
+ normalize
+
+
+
+ normalize
+
+
+
+ random
+
+
+
+
+ Index
+
+
+
+
+ Functions
+ +Functions
+anyMatch
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
a: Set<any> | any[]
+
+ -
+
b: Set<any> | any[]
+
+
Returns boolean
+
+ -
+
ensureArray
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
T
+
+
Parameters
+-
+
-
+
maybeArray: T | T[]
+
+
Returns T[]
+
+ -
+
msgId
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
from: string
+
+ -
+
seqno: Uint8Array
+
+
Returns Uint8Array
+
+ -
+
noSignMsgId
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
data: Uint8Array
+
+
Returns Uint8Array
+
+ -
+
normalizeInRpcMessage
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
T: { from?: any }
+
+
Parameters
+-
+
-
+
message: T & { from?: string | undefined; receivedFrom: string }
+
+ -
+
Optional peerId: string | undefined
+
+
Returns T & { from?: string | undefined; peerId?: string | undefined }
+
+ -
+
normalizeOutRpcMessage
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
T: { data?: any; from?: any }
+
+
Parameters
+-
+
-
+
message: T
+
+
Returns T & { data?: Uint8Array | undefined; from?: Uint8Array | undefined }
+
+ -
+
randomSeqno
+ -
+
+
-
+
-
+
+
Returns Uint8Array
+
+
+
+
+
+
+ Module record/tests/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_record_types_.html b/modules/_record_types_.html
new file mode 100644
index 0000000..97acc30
--- /dev/null
+++ b/modules/_record_types_.html
@@ -0,0 +1,213 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
test: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module record/types
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_stream_muxer_tests_base_test_.html b/modules/_stream_muxer_tests_base_test_.html
new file mode 100644
index 0000000..e124c34
--- /dev/null
+++ b/modules/_stream_muxer_tests_base_test_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Interfaces
+-
+
- Record +
+
+
+
+
+ Module stream-muxer/tests/base-test
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_stream_muxer_tests_close_test_.html b/modules/_stream_muxer_tests_close_test_.html
new file mode 100644
index 0000000..6d1d240
--- /dev/null
+++ b/modules/_stream_muxer_tests_close_test_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
common: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module stream-muxer/tests/close-test
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_stream_muxer_tests_index_.html b/modules/_stream_muxer_tests_index_.html
new file mode 100644
index 0000000..1af14a9
--- /dev/null
+++ b/modules/_stream_muxer_tests_index_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
common: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module stream-muxer/tests/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_stream_muxer_tests_mega_stress_test_.html b/modules/_stream_muxer_tests_mega_stress_test_.html
new file mode 100644
index 0000000..5a580d7
--- /dev/null
+++ b/modules/_stream_muxer_tests_mega_stress_test_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
common: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module stream-muxer/tests/mega-stress-test
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_stream_muxer_tests_spawner_.html b/modules/_stream_muxer_tests_spawner_.html
new file mode 100644
index 0000000..7e459a0
--- /dev/null
+++ b/modules/_stream_muxer_tests_spawner_.html
@@ -0,0 +1,245 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
common: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module stream-muxer/tests/spawner
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_stream_muxer_tests_stress_test_.html b/modules/_stream_muxer_tests_stress_test_.html
new file mode 100644
index 0000000..79c5122
--- /dev/null
+++ b/modules/_stream_muxer_tests_stress_test_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Muxer: any
+
+ -
+
nStreams: any
+
+ -
+
nMsg: any
+
+ -
+
limit: any
+
+
Returns Promise<void>
+
+ -
+
+
+
+
+
+ Module stream-muxer/tests/stress-test
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_stream_muxer_types_.html b/modules/_stream_muxer_types_.html
new file mode 100644
index 0000000..986f2a4
--- /dev/null
+++ b/modules/_stream_muxer_types_.html
@@ -0,0 +1,344 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
common: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module stream-muxer/types
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_topology_index_.html b/modules/_topology_index_.html
new file mode 100644
index 0000000..c8f9653
--- /dev/null
+++ b/modules/_topology_index_.html
@@ -0,0 +1,318 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Muxed
+
+
+
+
+
+ Muxer
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Interfaces
+-
+
- Muxed
Stream
+ - Muxer +
- Muxer
Factory
+
Type aliases
+-
+
- Muxed
Timeline
+ - Muxer
Options
+ - Sink +
Type aliases
+MuxedTimeline
+
+
+
+
+ Type declaration
+-
+
-
+
Optional close?: undefined | number
+
+ -
+
open: number
+
+
MuxerOptions
+
+
+
+
+ Type declaration
+-
+
-
+
Optional max
+Msg Size?: undefined | number
+ -
+
on
+Stream: (stream: MuxedStream) => void -
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
stream: MuxedStream
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
-
+
on
+Stream End: (stream: MuxedStream) => void -
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
stream: MuxedStream
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Sink
+ + +
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
source: Uint8Array
+
+
Returns Promise<Uint8Array>
+
+ -
+
+ -
+
+
+
+
+
+ Module topology/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_topology_multicodec_topology_.html b/modules/_topology_multicodec_topology_.html
new file mode 100644
index 0000000..740fe19
--- /dev/null
+++ b/modules/_topology_multicodec_topology_.html
@@ -0,0 +1,377 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Peer
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Classes
+-
+
- Topology +
Type aliases
+-
+
- Connection +
- Handlers +
- Options +
- Peer
Id
+
Type aliases
+Connection
+ + +Handlers
+ + +
+
+ Type declaration
+-
+
-
+
Optional on
+Connect?: ((peerId: PeerId, conn: Connection) => void) | undefined ++++-
+
- protocol "onConnect" handler +
+ -
+
Optional on
+Disconnect?: ((peerId: PeerId, error?: Error | undefined) => void) | undefined ++++-
+
- protocol "onDisconnect" handler +
+
Options
+ + +
+
+ Type declaration
+-
+
-
+
Optional handlers?: Handlers | undefined
+
+ -
+
Optional max?: number | undefined
+++++-
+
- maximum needed connections. +
+ -
+
Optional min?: number | undefined
+++++-
+
- minimum needed connections. +
+
PeerId
+
+
+
+
+
+
+
+ Module topology/multicodec-topology
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_topology_tests_multicodec_topology_.html b/modules/_topology_tests_multicodec_topology_.html
new file mode 100644
index 0000000..f81272f
--- /dev/null
+++ b/modules/_topology_tests_multicodec_topology_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Multicodec
+
+
+
+
+
+ Peer
+
+
+
+
+
+ Topology
+
+
+
+
+
+
+
+ Const Multicodec
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+
+
+ Classes
+ +Type aliases
+-
+
- Connection +
- Handlers +
- Multiaddr +
- Multicodec
Options
+ - Peer
Id
+ - Topology
Options
+
Variables
+ +Type aliases
+Connection
+ + +Handlers
+ + +
+
+ Type declaration
+-
+
-
+
Optional on
+Connect?: ((peerId: PeerId, conn: Connection) => void) | undefined ++++-
+
- protocol "onConnect" handler +
+ -
+
Optional on
+Disconnect?: ((peerId: PeerId, error?: Error | undefined) => void) | undefined ++++-
+
- protocol "onDisconnect" handler +
+
Multiaddr
+ + +MulticodecOptions
+
+
+
+
+ Type declaration
+-
+
-
+
handlers: Required<Handlers>
+
+ -
+
multicodecs: string[]
+++++-
+
- protocol multicodecs +
+
PeerId
+
+
+ TopologyOptions
+
+
+
+
+ Type declaration
+-
+
-
+
Optional handlers?: { onConnect?: ((peerId: PeerId, conn: Connection) => void) | undefined; onDisconnect?: ((peerId: PeerId, error?: Error | undefined) => void) | undefined } | undefined
+
+ -
+
Optional max?: number | undefined
+++++-
+
- maximum needed connections. +
+ -
+
Optional min?: number | undefined
+++++-
+
- minimum needed connections. +
+
Variables
+Const MulticodecTopology_base
+
+
+
+
+
+
+
+ Module topology/tests/multicodec-topology
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_topology_tests_topology_.html b/modules/_topology_tests_topology_.html
new file mode 100644
index 0000000..90552e0
--- /dev/null
+++ b/modules/_topology_tests_topology_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
test: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module topology/tests/topology
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_transport_errors_.html b/modules/_transport_errors_.html
new file mode 100644
index 0000000..05a59f6
--- /dev/null
+++ b/modules/_transport_errors_.html
@@ -0,0 +1,213 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
test: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module transport/errors
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_transport_tests_dial_test_.html b/modules/_transport_tests_dial_test_.html
new file mode 100644
index 0000000..4f76860
--- /dev/null
+++ b/modules/_transport_tests_dial_test_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Classes
+-
+
- Abort
Error
+
+
+
+
+
+ Module transport/tests/dial-test
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_transport_tests_filter_test_.html b/modules/_transport_tests_filter_test_.html
new file mode 100644
index 0000000..2bc9820
--- /dev/null
+++ b/modules/_transport_tests_filter_test_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
common: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module transport/tests/filter-test
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_transport_tests_index_.html b/modules/_transport_tests_index_.html
new file mode 100644
index 0000000..e4effb6
--- /dev/null
+++ b/modules/_transport_tests_index_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
common: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module transport/tests/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_transport_tests_listen_test_.html b/modules/_transport_tests_listen_test_.html
new file mode 100644
index 0000000..4dc18ec
--- /dev/null
+++ b/modules/_transport_tests_listen_test_.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
common: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module transport/tests/listen-test
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_transport_tests_utils_index_.html b/modules/_transport_tests_utils_index_.html
new file mode 100644
index 0000000..a7227fd
--- /dev/null
+++ b/modules/_transport_tests_utils_index_.html
@@ -0,0 +1,239 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
common: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module transport/tests/utils/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_transport_types_.html b/modules/_transport_types_.html
new file mode 100644
index 0000000..30d8c51
--- /dev/null
+++ b/modules/_transport_types_.html
@@ -0,0 +1,325 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ is
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- is
Valid Tick
+
Functions
+isValidTick
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
date: number
+
+ -
+
Optional ms: undefined | number
+
+
Returns boolean
+
+ -
+
+
+
+
+
+ Module transport/types
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_utils_peers_.html b/modules/_utils_peers_.html
new file mode 100644
index 0000000..a033102
--- /dev/null
+++ b/modules/_utils_peers_.html
@@ -0,0 +1,1895 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Multiaddr
+
+
+
+
+
+ Multiaddr
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Interfaces
+-
+
- Listener +
- Transport +
- Transport
Factory
+ - Upgrader +
Type aliases
+ +Type aliases
+MultiaddrConnection
+
+
+
+
+ Type declaration
+-
+
-
+
close: (err?: Error) => Promise<void>
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Optional err: Error
+
+
Returns Promise<void>
+
+ -
+
+ -
+
+ -
+
-
+
conn: unknown
+
+ -
+
Optional local
+Addr?: Multiaddr
+ -
+
remote
+Addr: Multiaddr
+ -
+
sink: Sink
+
+ -
+
source: () => AsyncIterable<Uint8Array>
+-
+
-
+
-
+
+
-
+
-
+
Returns AsyncIterable<Uint8Array>
+
+
+ -
+
+ -
+
-
+
timeline: MultiaddrConnectionTimeline
+
+
MultiaddrConnectionTimeline
+
+
+
+
+ Type declaration
+-
+
-
+
Optional close?: undefined | number
+
+ -
+
open: number
+
+ -
+
Optional upgraded?: undefined | number
+
+
+
+
+
+
+ Module utils/peers
+
+
+
+
+
+
+
\ No newline at end of file
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Variables
+-
+
- _exports +
Variables
+Const _exports
+ + +
+
+ Type declaration
+-
+
-
+
[n: number]: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
length: number
+
+ -
+
[
+Symbol.iterator]: function -
+
+
-
+
-
+
+
Returns IterableIterator<{ id: string; privKey: string; pubKey: string }>
+
+
+ -
+
+
-
+
[
+Symbol.unscopables]: function -
+
+
-
+
-
+
+
Returns { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean }
+-
+
-
+
copy
+Within: boolean
+ -
+
entries: boolean
+
+ -
+
fill: boolean
+
+ -
+
find: boolean
+
+ -
+
find
+Index: boolean
+ -
+
keys: boolean
+
+ -
+
values: boolean
+
+
+ -
+
+ -
+
+
-
+
concat: function
+-
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Rest ...items: ConcatArray<{ id: string; privKey: string; pubKey: string }>[]
+
+
Returns { id: string; privKey: string; pubKey: string }[]
+
+ -
+
-
+
+
Parameters
+-
+
-
+
Rest ...items: ({ id: string; privKey: string; pubKey: string } | ConcatArray<{ id: string; privKey: string; pubKey: string }>)[]
+
+
Returns { id: string; privKey: string; pubKey: string }[]
+
+ -
+
+ -
+
+
-
+
copy
+Within: function -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
target: number
+
+ -
+
start: number
+
+ -
+
Optional end: number | undefined
+
+
Returns { id: string; privKey: string; pubKey: string }[]
+
+ -
+
+ -
+
+
-
+
entries: function
+-
+
+
-
+
-
+
+
Returns IterableIterator<[number, { id: string; privKey: string; pubKey: string }]>
+
+
+ -
+
+
-
+
every: function
+-
+
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
S: { id: string; privKey: string; pubKey: string }
+
+
Parameters
+-
+
-
+
predicate: (value: { id: string; privKey: string; pubKey: string }, index: number, array: { id: string; privKey: string; pubKey: string }[]) => value is S
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
value: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
index: number
+
+ -
+
array: { id: string; privKey: string; pubKey: string }[]
+
+
Returns value is S
+
+ -
+
+ -
+
+ -
+
-
+
Optional thisArg: any
+
+
Returns this is S[]
+
+ -
+
-
+
+
Parameters
+-
+
-
+
predicate: (value: { id: string; privKey: string; pubKey: string }, index: number, array: { id: string; privKey: string; pubKey: string }[]) => unknown
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
value: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
index: number
+
+ -
+
array: { id: string; privKey: string; pubKey: string }[]
+
+
Returns unknown
+
+ -
+
+ -
+
+ -
+
-
+
Optional thisArg: any
+
+
Returns boolean
+
+ -
+
+ -
+
+
-
+
fill: function
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
value: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
Optional start: number | undefined
+
+ -
+
Optional end: number | undefined
+
+
Returns { id: string; privKey: string; pubKey: string }[]
+
+ -
+
+ -
+
+
-
+
filter: function
+-
+
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
S_1: { id: string; privKey: string; pubKey: string }
+
+
Parameters
+-
+
-
+
predicate: (value: { id: string; privKey: string; pubKey: string }, index: number, array: { id: string; privKey: string; pubKey: string }[]) => value is S_1
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
value: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
index: number
+
+ -
+
array: { id: string; privKey: string; pubKey: string }[]
+
+
Returns value is S_1
+
+ -
+
+ -
+
+ -
+
-
+
Optional thisArg: any
+
+
Returns S_1[]
+
+ -
+
-
+
+
Parameters
+-
+
-
+
predicate: (value: { id: string; privKey: string; pubKey: string }, index: number, array: { id: string; privKey: string; pubKey: string }[]) => unknown
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
value: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
index: number
+
+ -
+
array: { id: string; privKey: string; pubKey: string }[]
+
+
Returns unknown
+
+ -
+
+ -
+
+ -
+
-
+
Optional thisArg: any
+
+
Returns { id: string; privKey: string; pubKey: string }[]
+
+ -
+
+ -
+
+
-
+
find: function
+-
+
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
S_2: { id: string; privKey: string; pubKey: string }
+
+
Parameters
+-
+
-
+
predicate: (this: void, value: { id: string; privKey: string; pubKey: string }, index: number, obj: { id: string; privKey: string; pubKey: string }[]) => value is S_2
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
this: void
+
+ -
+
value: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
index: number
+
+ -
+
obj: { id: string; privKey: string; pubKey: string }[]
+
+
Returns value is S_2
+
+ -
+
+ -
+
+ -
+
-
+
Optional thisArg: any
+
+
Returns S_2 | undefined
+
+ -
+
-
+
+
Parameters
+-
+
-
+
predicate: (value: { id: string; privKey: string; pubKey: string }, index: number, obj: { id: string; privKey: string; pubKey: string }[]) => unknown
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
value: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
index: number
+
+ -
+
obj: { id: string; privKey: string; pubKey: string }[]
+
+
Returns unknown
+
+ -
+
+ -
+
+ -
+
-
+
Optional thisArg: any
+
+
Returns { id: string; privKey: string; pubKey: string } | undefined
+
+ -
+
+ -
+
+
-
+
find
+Index: function -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
predicate: (value: { id: string; privKey: string; pubKey: string }, index: number, obj: { id: string; privKey: string; pubKey: string }[]) => unknown
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
value: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
index: number
+
+ -
+
obj: { id: string; privKey: string; pubKey: string }[]
+
+
Returns unknown
+
+ -
+
+ -
+
+ -
+
-
+
Optional thisArg: any
+
+
Returns number
+
+ -
+
+ -
+
+
-
+
flat: function
+-
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
A
+
+ -
+
D: number = 1
+
+
Parameters
+-
+
-
+
this: A
+
+ -
+
Optional depth: D | undefined
+
+
Returns FlatArray<A, D>[]
+
+ -
+
+ -
+
+
-
+
flat
+Map: function -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
U_3
+
+ -
+
This = undefined
+
+
Parameters
+-
+
-
+
callback: (this: This, value: { id: string; privKey: string; pubKey: string }, index: number, array: { id: string; privKey: string; pubKey: string }[]) => U_3 | readonly U_3[]
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
this: This
+
+ -
+
value: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
index: number
+
+ -
+
array: { id: string; privKey: string; pubKey: string }[]
+
+
Returns U_3 | readonly U_3[]
+
+ -
+
+ -
+
+ -
+
-
+
Optional thisArg: This | undefined
+
+
Returns U_3[]
+
+ -
+
+ -
+
+
-
+
for
+Each: function -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
callbackfn: (value: { id: string; privKey: string; pubKey: string }, index: number, array: { id: string; privKey: string; pubKey: string }[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
value: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
index: number
+
+ -
+
array: { id: string; privKey: string; pubKey: string }[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
-
+
Optional thisArg: any
+
+
Returns void
+
+ -
+
+ -
+
+
-
+
includes: function
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
searchElement: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
Optional fromIndex: number | undefined
+
+
Returns boolean
+
+ -
+
+ -
+
+
-
+
index
+Of: function -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
searchElement: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
Optional fromIndex: number | undefined
+
+
Returns number
+
+ -
+
+ -
+
+
-
+
join: function
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional separator: string | undefined
+
+
Returns string
+
+ -
+
+ -
+
+
-
+
keys: function
+-
+
+
-
+
-
+
+
Returns IterableIterator<number>
+
+
+ -
+
+
-
+
last
+Index Of: function -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
searchElement: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
Optional fromIndex: number | undefined
+
+
Returns number
+
+ -
+
+ -
+
+
-
+
map: function
+-
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
U
+
+
Parameters
+-
+
-
+
callbackfn: (value: { id: string; privKey: string; pubKey: string }, index: number, array: { id: string; privKey: string; pubKey: string }[]) => U
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
value: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
index: number
+
+ -
+
array: { id: string; privKey: string; pubKey: string }[]
+
+
Returns U
+
+ -
+
+ -
+
+ -
+
-
+
Optional thisArg: any
+
+
Returns U[]
+
+ -
+
+ -
+
+
-
+
pop: function
+-
+
+
-
+
-
+
+
Returns { id: string; privKey: string; pubKey: string } | undefined
+
+
+ -
+
+
-
+
push: function
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Rest ...items: { id: string; privKey: string; pubKey: string }[]
+
+
Returns number
+
+ -
+
+ -
+
+
-
+
reduce: function
+-
+
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
callbackfn: (previousValue: { id: string; privKey: string; pubKey: string }, currentValue: { id: string; privKey: string; pubKey: string }, currentIndex: number, array: { id: string; privKey: string; pubKey: string }[]) => { id: string; privKey: string; pubKey: string }
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
previousValue: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
currentValue: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
currentIndex: number
+
+ -
+
array: { id: string; privKey: string; pubKey: string }[]
+
+
Returns { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
+ -
+
+ -
+
Returns { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
+
Parameters
+-
+
-
+
callbackfn: (previousValue: { id: string; privKey: string; pubKey: string }, currentValue: { id: string; privKey: string; pubKey: string }, currentIndex: number, array: { id: string; privKey: string; pubKey: string }[]) => { id: string; privKey: string; pubKey: string }
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
previousValue: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
currentValue: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
currentIndex: number
+
+ -
+
array: { id: string; privKey: string; pubKey: string }[]
+
+
Returns { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
+ -
+
+ -
+
-
+
initialValue: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
Returns { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
+
Type parameters
+-
+
-
+
U_1
+
+
Parameters
+-
+
-
+
callbackfn: (previousValue: U_1, currentValue: { id: string; privKey: string; pubKey: string }, currentIndex: number, array: { id: string; privKey: string; pubKey: string }[]) => U_1
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
previousValue: U_1
+
+ -
+
currentValue: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
currentIndex: number
+
+ -
+
array: { id: string; privKey: string; pubKey: string }[]
+
+
Returns U_1
+
+ -
+
+ -
+
+ -
+
-
+
initialValue: U_1
+
+
Returns U_1
+
+ -
+
+ -
+
+
-
+
reduce
+Right: function -
+
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
callbackfn: (previousValue: { id: string; privKey: string; pubKey: string }, currentValue: { id: string; privKey: string; pubKey: string }, currentIndex: number, array: { id: string; privKey: string; pubKey: string }[]) => { id: string; privKey: string; pubKey: string }
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
previousValue: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
currentValue: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
currentIndex: number
+
+ -
+
array: { id: string; privKey: string; pubKey: string }[]
+
+
Returns { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
+ -
+
+ -
+
Returns { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
+
Parameters
+-
+
-
+
callbackfn: (previousValue: { id: string; privKey: string; pubKey: string }, currentValue: { id: string; privKey: string; pubKey: string }, currentIndex: number, array: { id: string; privKey: string; pubKey: string }[]) => { id: string; privKey: string; pubKey: string }
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
previousValue: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
currentValue: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
currentIndex: number
+
+ -
+
array: { id: string; privKey: string; pubKey: string }[]
+
+
Returns { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
+ -
+
+ -
+
-
+
initialValue: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
Returns { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
+
Type parameters
+-
+
-
+
U_2
+
+
Parameters
+-
+
-
+
callbackfn: (previousValue: U_2, currentValue: { id: string; privKey: string; pubKey: string }, currentIndex: number, array: { id: string; privKey: string; pubKey: string }[]) => U_2
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
previousValue: U_2
+
+ -
+
currentValue: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
currentIndex: number
+
+ -
+
array: { id: string; privKey: string; pubKey: string }[]
+
+
Returns U_2
+
+ -
+
+ -
+
+ -
+
-
+
initialValue: U_2
+
+
Returns U_2
+
+ -
+
+ -
+
+
-
+
reverse: function
+-
+
+
-
+
-
+
+
Returns { id: string; privKey: string; pubKey: string }[]
+
+
+ -
+
+
-
+
shift: function
+-
+
+
-
+
-
+
+
Returns { id: string; privKey: string; pubKey: string } | undefined
+
+
+ -
+
+
-
+
slice: function
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional start: number | undefined
+
+ -
+
Optional end: number | undefined
+
+
Returns { id: string; privKey: string; pubKey: string }[]
+
+ -
+
+ -
+
+
-
+
some: function
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
predicate: (value: { id: string; privKey: string; pubKey: string }, index: number, array: { id: string; privKey: string; pubKey: string }[]) => unknown
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
value: { id: string; privKey: string; pubKey: string }
+-
+
-
+
id: string
+
+ -
+
priv
+Key: string
+ -
+
pub
+Key: string
+
+ -
+
-
+
index: number
+
+ -
+
array: { id: string; privKey: string; pubKey: string }[]
+
+
Returns unknown
+
+ -
+
+ -
+
+ -
+
-
+
Optional thisArg: any
+
+
Returns boolean
+
+ -
+
+ -
+
+
-
+
sort: function
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional compareFn: ((a: { id: string; privKey: string; pubKey: string }, b: { id: string; privKey: string; pubKey: string }) => number) | undefined
+
+
Returns { id: string; privKey: string; pubKey: string }[]
+
+ -
+
+ -
+
+
-
+
splice: function
+-
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
start: number
+
+ -
+
Optional deleteCount: number | undefined
+
+
Returns { id: string; privKey: string; pubKey: string }[]
+
+ -
+
-
+
+
Parameters
+-
+
-
+
start: number
+
+ -
+
deleteCount: number
+
+ -
+
Rest ...items: { id: string; privKey: string; pubKey: string }[]
+
+
Returns { id: string; privKey: string; pubKey: string }[]
+
+ -
+
+ -
+
+
-
+
to
+Locale String: function -
+
+
-
+
-
+
+
Returns string
+
+
+ -
+
+
-
+
to
+String: function -
+
+
-
+
-
+
+
Returns string
+
+
+ -
+
+
-
+
unshift: function
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Rest ...items: { id: string; privKey: string; pubKey: string }[]
+
+
Returns number
+
+ -
+
+ -
+
+
-
+
values: function
+-
+
+
-
+
-
+
+
Returns IterableIterator<{ id: string; privKey: string; pubKey: string }>
+
+
+ -
+
+
An implementation of the js-libp2p connection. + Any libp2p transport should use an upgrader to return this connection.
+