@dxos/broadcast - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

dist/broadcast.js

@@ -233,3 +233,3 @@ "use strict";
    * @param {Buffer} packetEncoded
-   * @returns {boolean} Returns true if the decoding was successful.
+   * @returns {(Packet|undefined)} Returns the packet if the decoding was successful.
    */
@@ -257,6 +257,5 @@
 
-      return true;
+      return packet;
     } catch (err) {
       this.emit('subscribe-error', err);
-      return false;
     }
@@ -263,0 +262,0 @@ }

package.json

 {
   "name": "@dxos/broadcast",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Abstract module to send broadcast messages.",
@@ -5,0 +5,0 @@ "homepage": "https://github.com/dxos/broadcast#readme",

README.md

@@ -112,3 +112,3 @@ # Broadcast
   - `subscribe: (onPacket) => unsubscribeFunction`: Defines how to subscribe to incoming packets.
-    - `onPacket: (data: Buffer) => boolean`: Callback to process incoming data. It returns true if the broadcast could decode the message or false if not.
+    - `onPacket: (data: Buffer) => (Packet|undefined)`: Callback to process incoming data. It returns true if the broadcast could decode the message or false if not.
     - `unsubscribeFunction: Function`: Defines a way to unsubscribe from listening messages if the broadcast stop working. Helpful if you are working with streams and event emitters.
@@ -115,0 +115,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

72892

decreased by-0.01%

Lines of code

404

decreased by-0.25%

No dependency changes