diff --git a/classes/_libp2p_floodsub.FloodSub.html b/classes/_libp2p_floodsub.FloodSub.html index 02a80eccf2..47beddbf13 100644 --- a/classes/_libp2p_floodsub.FloodSub.html +++ b/classes/_libp2p_floodsub.FloodSub.html @@ -1,7 +1,7 @@
Optional
init: FloodSubInitPrivate
#privateIf router can relay received messages, even if not subscribed
+Optional
init: FloodSubInitPrivate
#privateIf router can relay received messages, even if not subscribed
if publish should emit to self, if subscribed
Protected
enabledThe signature policy to follow by default
Protected
logA list of multicodecs that contain the pubsub protocol name.
Map of peer streams
-List of our subscriptions
+List of our subscriptions
Topic validator map
Keyed by topic Topic validators are functions with the following input:
@@ -70,24 +70,24 @@Optional
options: boolean | AddEventListenerOptionsNotifies the router that a peer has been connected
Normalizes the message and signs it, if signing is enabled. Should be used by the routers to create the message to send.
-Decode a Uint8Array into an RPC object
-Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
+Decode a Uint8Array into an RPC object
+Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Encode RPC object into a Uint8Array. This can be override to use a custom router protobuf.
-Encode an RPC object into a Uint8Array
-The default msgID implementation +
Encode an RPC object into a Uint8Array
+The default msgID implementation Child class can override this.
Responsible for processing each RPC message received by other peers.
Handles an rpc request from a peer
Handles a subscription change from a peer
Publishes messages to all subscribed peers
Optional
data: Uint8ArrayPublish message created. Forward it to the peers.
-Optional
listener: null | EventHandler<PubSubEvents[K]>Optional
options: boolean | EventListenerOptionsSend an rpc object to a peer
+Optional
listener: null | EventHandler<PubSubEvents[K]>Optional
options: boolean | EventListenerOptionsUnregister the pubsub protocol and the streams with other peers will be closed.
diff --git a/classes/_libp2p_interface.errors.AbortError.html b/classes/_libp2p_interface.errors.AbortError.html index 3621ebd4c3..6451207505 100644 --- a/classes/_libp2p_interface.errors.AbortError.html +++ b/classes/_libp2p_interface.errors.AbortError.html @@ -1,7 +1,7 @@When this error is thrown it means an operation was aborted,
usually in response to the abort
event being emitted by an
AbortSignal.
Optional
causeReadonly
codeOptional
stackReadonly
typeStatic
Readonly
codeStatic
Optional
prepareOptional override for formatting stack traces
+Optional
causeReadonly
codeOptional
stackReadonly
typeStatic
Readonly
codeStatic
Optional
prepareOptional override for formatting stack traces
Static
stackStatic
Readonly
typeStatic
captureCreate .stack property on a target object
-Optional
constructorOpt: FunctionGenerated using TypeDoc
Static
stackStatic
Readonly
typeStatic
captureCreate .stack property on a target object
+Optional
constructorOpt: FunctionGenerated using TypeDoc
Optional
causeReadonly
codeReadonly
propsOptional
stackStatic
Optional
prepareOptional override for formatting stack traces
+Optional
causeReadonly
codeReadonly
propsOptional
stackStatic
Optional
prepareOptional override for formatting stack traces
Static
stackStatic
captureCreate .stack property on a target object
-Optional
constructorOpt: FunctionGenerated using TypeDoc
Static
stackStatic
captureCreate .stack property on a target object
+Optional
constructorOpt: FunctionGenerated using TypeDoc
Optional
causeOptional
stackStatic
Readonly
codeStatic
Optional
prepareOptional override for formatting stack traces
+Optional
causeOptional
stackStatic
Readonly
codeStatic
Optional
prepareOptional override for formatting stack traces
Static
stackStatic
captureCreate .stack property on a target object
-Optional
constructorOpt: FunctionGenerated using TypeDoc
Static
stackStatic
captureCreate .stack property on a target object
+Optional
constructorOpt: FunctionGenerated using TypeDoc
Optional
causeOptional
stackStatic
Readonly
codeStatic
Optional
prepareOptional override for formatting stack traces
+Optional
causeOptional
stackStatic
Readonly
codeStatic
Optional
prepareOptional override for formatting stack traces
Static
stackStatic
captureCreate .stack property on a target object
-Optional
constructorOpt: FunctionGenerated using TypeDoc
Static
stackStatic
captureCreate .stack property on a target object
+Optional
constructorOpt: FunctionGenerated using TypeDoc
Optional
causeOptional
stackStatic
Readonly
codeStatic
Optional
prepareOptional override for formatting stack traces
+Optional
causeOptional
stackStatic
Readonly
codeStatic
Optional
prepareOptional override for formatting stack traces
Static
stackStatic
captureCreate .stack property on a target object
-Optional
constructorOpt: FunctionGenerated using TypeDoc
Static
stackStatic
captureCreate .stack property on a target object
+Optional
constructorOpt: FunctionGenerated using TypeDoc
An implementation of a typed event target etc
-Private
#listenersOptional
options: boolean | AddEventListenerOptionsPrivate
#listenersOptional
options: boolean | AddEventListenerOptionsDispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
-Optional
listener: null | EventHandler<EventMap[K]>Optional
options: boolean | EventListenerOptionsGenerated using TypeDoc
Optional
listener: null | EventHandler<EventMap[K]>Optional
options: boolean | EventListenerOptionsGenerated using TypeDoc
FloodSub (aka dumbsub is an implementation of pubsub focused on delivering an API for Publish/Subscribe, but with no CastTree Forming (it just floods the network).
-