chore: update decodeStream

softvisio-node · Dec 22, 2024 · 023849c · 023849c
1 parent 984d3db
commit 023849c
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -46,10 +46,10 @@ Throws error if unable to decode message.
 - `data` {Buffer|ArrayBuffer|Uint8Array|string} Data to decode.
 - `offset?` {integer} Offset of the message start in the passed data. **Default:** `0`.
 - Returns: {Object}:
-    - `value?` {any} Decoded data.
-    - `offset?` {integer} Offset of the decoded message end in the passed data.
+    - `value` {any} Decoded data.
+    - `offset` {integer} Offset of the decoded message end in the passed data.
 
-Returns empty {Object} if message is incomplete.
+Returns {undefined} if message is incomplete.
 
 Throws error if unable to decode message.
 

diff --git a/docs/README.md b/docs/README.md
@@ -42,10 +42,10 @@ Throws error if unable to decode message.
 - `data` {Buffer|ArrayBuffer|Uint8Array|string} Data to decode.
 - `offset?` {integer} Offset of the message start in the passed data. **Default:** `0`.
 - Returns: {Object}:
-    - `value?` {any} Decoded data.
-    - `offset?` {integer} Offset of the decoded message end in the passed data.
+    - `value` {any} Decoded data.
+    - `offset` {integer} Offset of the decoded message end in the passed data.
 
-Returns empty {Object} if message is incomplete.
+Returns {undefined} if message is incomplete.
 
 Throws error if unable to decode message.
 

diff --git a/lib/decode.js b/lib/decode.js
@@ -436,7 +436,7 @@ export function decodeStream ( buffer, offset ) {
 
         // message is incomplete
         if ( decoder.rangeError || e.code === "ERR_BUFFER_OUT_OF_BOUNDS" || e.code === "ERR_OUT_OF_RANGE" ) {
-            return {};
+            return;
         }
 
         throw e;