kafka-observe - npm Package Compare versions

Comparing version 2.1.1-beta-14 to 2.1.1-beta-15

package.json

 {
   "name": "kafka-observe",
-  "version": "2.1.1-beta-14",
+  "version": "2.1.1-beta-15",
   "description": "",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -126,2 +126,18 @@ # kafka-observe
 
+## streamReader
+
+Helper to convert consumed stream data to json object. needs to be initialized and returns a function that can be used to read the consumed data parts
+```javascript
+const { streamReader } = require("kafka-observe")(options);
+const _streamReader = streamReader();
+
+_streamReader({
+    event: {},
+    id: "uniqueId",
+    onStatus: (status) => console.log(status) // A callback to receive status about the stream 
+}).then((event) => {
+	// do something with the event
+});
+```
+
 ## streamCallback
@@ -128,0 +144,0 @@

test/unit/helpers/timer.helpers.test.js

 const { expect } = require("chai");
 
-const { timerHelpers } = require("../helpers");
+const { timerHelpers } = require("../../../helpers");
 
@@ -5,0 +5,0 @@ describe("Timer helpers", function () {

No alert changes

Improved metrics

Total package byte prevSize

34724

increased by1.45%

Number of lines in readme file

199

increased by8.74%

No dependency changes