@regulaforensics/vp-frontend-document-components 7.2.1606 → 7.2.1608-nightly

package/README.md

@@ -1405,6 +1405,10 @@ The Document Reader web components are also available on <a href="https://storyb
 Logging can be helpful when you run into any issues.
 Logs contain information about how you use our products. That data helps Regula stuff to analyze and troubleshoot the cases you may experience.
 
+There are two ways to output logs: console or function callback.
+
+#### Console
+
 To initiate the process of logs collecting:
 
 **1.** Open the Developer menu in your browser.
@@ -1419,7 +1423,7 @@ localStorage.logger = 'main,wasm>console'
 
 **4.** Reload the page.
 
-**5.** Add the `log` setting to the `processParam`:
+**5.** Add the `log` setting to the `processParam` if you want to see logs from WASM:
 
 ```json
 {
@@ -1430,3 +1434,31 @@ localStorage.logger = 'main,wasm>console'
 ```
 
 **6.** Start image processing. Logs will be displayed in Console.
+
+#### Function callback
+
+**1.** Import logging service from library.
+
+```javascript
+import { Logger } from '@regulaforensics/vp-frontend-document-components';
+```
+
+**2.** Set the callback function.
+
+```javascript
+Logger.logListener = (log) => {
+    // ...
+    // do something with log
+    // ...
+};
+```
+
+**3.** Add the `log` setting to the `processParam` if you want to see logs from WASM:
+
+```json
+{
+  "processParam": {
+    "log": true
+  }
+}
+```