barkoder-cordova - npm Package Compare versions

Comparing version 1.3.0 to 1.3.1

package.json

 {
   "name": "barkoder-cordova",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Cordova plugin that connects to barkoderSDK which helps users scan barcodes with mobile devices",
@@ -5,0 +5,0 @@ "cordova": {

www/BarkoderScanner.js

@@ -1,331 +0,826 @@
-var exec = require('cordova/exec');
+var exec = require("cordova/exec");
 
 var barkoderScanner = "BarkoderScanner";
 
-  // - Initialize the BarkoderView
+// - Initialize the BarkoderView
 
-exports.initialize = function (width, height, x, y, success, error) {
-    exec(success, error, barkoderScanner, 'initialize', [width, height, x, y]);
+/**
+ * Initializes the Barkoder scanner with the specified dimensions and position
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.initialize = function(width, height, x, y, success, error) {
+  exec(success, error, barkoderScanner, "initialize", [width, height, x, y]);
 };
 
-  // - Register with license key
+// - Register with license key
 
-exports.registerWithLicenseKey = function (licenseKey, success, error) {
-    exec(success, error, barkoderScanner, 'registerWithLicenseKey', [licenseKey]);
+/**
+ * Registers the Barkoder scanner with the specified license key
+ * @param {*} licenseKey - The license key to register the Barkoder scanner
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.registerWithLicenseKey = function(licenseKey, success, error) {
+  exec(success, error, barkoderScanner, "registerWithLicenseKey", [licenseKey]);
 };
 
-  // - Setters
+// - Setters
 
-exports.setZoomFactor = function (zoomFactor, success, error) {
-    exec(success, error, barkoderScanner, 'setZoomFactor', [zoomFactor]);
+/**
+ * Sets the zoom factor for the device's camera, adjusting the level of zoom during barcode scanning
+ * @param {*} zoomFactor - The zoom factor to set. This should be a positive number
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setZoomFactor = function(zoomFactor, success, error) {
+  exec(success, error, barkoderScanner, "setZoomFactor", [zoomFactor]);
 };
 
-exports.setFlashEnabled = function (enabled, success, error) {
-    exec(success, error, barkoderScanner, 'setFlashEnabled', [enabled]);
+/**
+ * Enables or disables the device's flash (torch) for illumination during barcode scanning
+ * @param {*} enabled - Set to true to enable the flash, false to disable it.
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setFlashEnabled = function(enabled, success, error) {
+  exec(success, error, barkoderScanner, "setFlashEnabled", [enabled]);
 };
 
-exports.startCamera = function (success, error) {
-    exec(success, error, barkoderScanner, 'startCamera', []);
+exports.startCamera = function(success, error) {
+  exec(success, error, barkoderScanner, "startCamera", []);
 };
 
-exports.startScanning = function (success, error) {
-    exec(success, error, barkoderScanner, 'startScanning', []);
+/**
+ * Initiates the barcode scanning process, allowing the application to detect and decode barcodes from the device's camera feed
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.startScanning = function(success, error) {
+  exec(success, error, barkoderScanner, "startScanning", []);
 };
 
-exports.stopScanning = function (success, error) {
-    exec(success, error, barkoderScanner, 'stopScanning', []);
+/**
+ * Halts the barcode scanning process, stopping the camera from capturing and processing barcode information
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.stopScanning = function(success, error) {
+  exec(success, error, barkoderScanner, "stopScanning", []);
 };
 
-exports.pauseScanning = function (success, error) {
-    exec(success, error, barkoderScanner, 'pauseScanning', []);
+/**
+ * Temporarily suspends the barcode scanning process, pausing the camera feed without completely stopping the scanning session
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.pauseScanning = function(success, error) {
+  exec(success, error, barkoderScanner, "pauseScanning", []);
 };
 
-exports.setLocationLineColor = function (hexColor, success, error) {
-    exec(success, error, barkoderScanner, 'setLocationLineColor', [hexColor]);
+/**
+ * Sets the color of the lines used to indicate the location of detected barcodes on the camera feed
+ * @param {*} hexColor - The color to set for the location lines, specified in hexadecimal format (e.g., '#FF0000' for red)
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setLocationLineColor = function(hexColor, success, error) {
+  exec(success, error, barkoderScanner, "setLocationLineColor", [hexColor]);
 };
 
-exports.setLocationLineWidth = function (lineWidth, success, error) {
-    exec(success, error, barkoderScanner, 'setLocationLineWidth', [lineWidth]);
+/**
+ * Sets the width of the lines indicating the location of detected barcodes on the camera feed
+ * @param {*} lineWidth - The width of the location lines, in pixels. Must be a positive number
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setLocationLineWidth = function(lineWidth, success, error) {
+  exec(success, error, barkoderScanner, "setLocationLineWidth", [lineWidth]);
 };
 
-exports.setRoiLineColor = function (hexColor, success, error) {
-    exec(success, error, barkoderScanner, 'setRoiLineColor', [hexColor]);
+/**
+ * Sets the color of the lines outlining the Region of Interest (ROI) for barcode scanning on the camera feed
+ * @param {*} hexColor - The color to set for the ROI lines, in hexadecimal format (e.g., '#FF0000' for red).
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setRoiLineColor = function(hexColor, success, error) {
+  exec(success, error, barkoderScanner, "setRoiLineColor", [hexColor]);
 };
 
-exports.setRoiLineWidth = function (lineWidth, success, error) {
-    exec(success, error, barkoderScanner, 'setRoiLineWidth', [lineWidth]);
+/**
+ * Sets the width of the lines outlining the Region of Interest (ROI) for barcode scanning on the camera feed
+ * @param {*} lineWidth - The width of the ROI lines, in pixels. This should be a positive number
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setRoiLineWidth = function(lineWidth, success, error) {
+  exec(success, error, barkoderScanner, "setRoiLineWidth", [lineWidth]);
 };
 
-exports.setRoiOverlayBackgroundColor = function (hexColor, success, error) {
-    exec(success, error, barkoderScanner, 'setRoiOverlayBackgroundColor', [hexColor]);
+/**
+ * Sets the background color of the overlay within the Region of Interest (ROI) for barcode scanning on the camera feed
+ * @param {*} hexColor - The background color to set for the ROI overlay, in hexadecimal format (e.g., '#FF0000' for red)
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setRoiOverlayBackgroundColor = function(hexColor, success, error) {
+  exec(success, error, barkoderScanner, "setRoiOverlayBackgroundColor", [
+    hexColor,
+  ]);
 };
 
-exports.setCloseSessionOnResultEnabled = function (enabled, success, error) {
-    exec(success, error, barkoderScanner, 'setCloseSessionOnResultEnabled', [enabled]);
+/**
+ * Enables or disables the automatic closing of the scanning session upon detecting a barcode result
+ * @param {*} enabled - Set to true to enable automatic session closure, false to disable it
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setCloseSessionOnResultEnabled = function(enabled, success, error) {
+  exec(success, error, barkoderScanner, "setCloseSessionOnResultEnabled", [
+    enabled,
+  ]);
 };
 
-exports.setImageResultEnabled = function (enabled, success, error) {
-    exec(success, error, barkoderScanner, 'setImageResultEnabled', [enabled]);
+/**
+ * Enables or disables the capturing and processing of image data when a barcode is successfully detected
+ * @param {*} enabled - Set to true to include an image in the result, false to exclude it
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setImageResultEnabled = function(enabled, success, error) {
+  exec(success, error, barkoderScanner, "setImageResultEnabled", [enabled]);
 };
 
-exports.setLocationInImageResultEnabled = function (enabled, success, error) {
-    exec(success, error, barkoderScanner, 'setLocationInImageResultEnabled', [enabled]);
+/**
+ * Enables or disables the inclusion of barcode location information within the image data result
+ * @param {*} enabled - Set to true to include location information in the image result, false to exclude it
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setLocationInImageResultEnabled = function(enabled, success, error) {
+  exec(success, error, barkoderScanner, "setLocationInImageResultEnabled", [
+    enabled,
+  ]);
 };
 
-exports.setRegionOfInterest = function (left, top, width, height, success, error) {
-    exec(success, error, barkoderScanner, 'setRegionOfInterest', [left, top, width, height]);
+/**
+ * Defines the Region of Interest (ROI) on the camera preview for barcode scanning, specifying an area where the application focuses on detecting barcodes
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setRegionOfInterest = function(
+  left,
+  top,
+  width,
+  height,
+  success,
+  error
+) {
+  exec(success, error, barkoderScanner, "setRegionOfInterest", [
+    left,
+    top,
+    width,
+    height,
+  ]);
 };
 
-exports.setThreadsLimit = function (threadsLimit, success, error) {
-    exec(success, error, barkoderScanner, 'setThreadsLimit', [threadsLimit]);
+/**
+ * Sets the threads limit
+ * @param {*} threadsLimit - The maximum number of threads to use for decoding
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setThreadsLimit = function(threadsLimit, success, error) {
+  exec(success, error, barkoderScanner, "setThreadsLimit", [threadsLimit]);
 };
 
-exports.setLocationInPreviewEnabled = function (enabled, success, error) {
-    exec(success, error, barkoderScanner, 'setLocationInPreviewEnabled', [enabled]);
+/**
+ * Enables or disables the display of barcode location information on the camera preview
+ * @param {*} enabled - Set to true to display location information in the scanning preview, false to hide it
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setLocationInPreviewEnabled = function(enabled, success, error) {
+  exec(success, error, barkoderScanner, "setLocationInPreviewEnabled", [
+    enabled,
+  ]);
 };
 
-exports.setPinchToZoomEnabled = function (enabled, success, error) {
-    exec(success, error, barkoderScanner, 'setPinchToZoomEnabled', [enabled]);
+/**
+ * Enables or disables the pinch-to-zoom feature for adjusting the zoom level during barcode scanning
+ * @param {*} enabled - Set to true to enable pinch-to-zoom gesture, false to disable it
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setPinchToZoomEnabled = function(enabled, success, error) {
+  exec(success, error, barkoderScanner, "setPinchToZoomEnabled", [enabled]);
 };
 
-exports.setRegionOfInterestVisible = function (regionOfInterestVisible, success, error) {
-    exec(success, error, barkoderScanner, 'setRegionOfInterestVisible', [regionOfInterestVisible]);
+/**
+ * Sets the visibility of the Region of Interest (ROI) on the camera preview
+ * @param {*} regionOfInterestVisible - Set to true to make the region of interest visible, false to hide it
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setRegionOfInterestVisible = function(
+  regionOfInterestVisible,
+  success,
+  error
+) {
+  exec(success, error, barkoderScanner, "setRegionOfInterestVisible", [
+    regionOfInterestVisible,
+  ]);
 };
 
-exports.setBarkoderResolution = function (resolution, success, error) {
-    exec(success, error, barkoderScanner, 'setBarkoderResolution', [resolution]);
+/**
+ * Sets the resolution for barcode scanning
+ * @param {*} resolution - The resolution to set for the barcode scanner
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setBarkoderResolution = function(resolution, success, error) {
+  exec(success, error, barkoderScanner, "setBarkoderResolution", [resolution]);
 };
 
-exports.setBeepOnSuccessEnabled = function (enabled, success, error) {
-    exec(success, error, barkoderScanner, 'setBeepOnSuccessEnabled', [enabled]);
+/**
+ * Enables or disables the audible beep sound upon successfully decoding a barcode
+ * @param {*} enabled - Set to true to enable the beep sound, false to disable it
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setBeepOnSuccessEnabled = function(enabled, success, error) {
+  exec(success, error, barkoderScanner, "setBeepOnSuccessEnabled", [enabled]);
 };
 
-exports.setVibrateOnSuccessEnabled = function (enabled, success, error) {
-    exec(success, error, barkoderScanner, 'setVibrateOnSuccessEnabled', [enabled]);
+/**
+ * Enables or disables the device vibration upon successfully decoding a barcode.
+ * @param {*} enabled - Set to true to enable vibration, false to disable it
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setVibrateOnSuccessEnabled = function(enabled, success, error) {
+  exec(success, error, barkoderScanner, "setVibrateOnSuccessEnabled", [
+    enabled,
+  ]);
 };
 
-exports.showLogMessages = function (showLogMessages, success, error) {
-    exec(success, error, barkoderScanner, 'showLogMessages', [showLogMessages]);
+exports.showLogMessages = function(showLogMessages, success, error) {
+  exec(success, error, barkoderScanner, "showLogMessages", [showLogMessages]);
 };
 
-exports.setBarcodeTypeLengthRange = function (type, min, max, success, error) {
-    exec(success, error, barkoderScanner, 'setBarcodeTypeLengthRange', [type, min, max]);
+/**
+ * Sets the length range for the specified barcode type
+ * @param {*} type - The barcode type to check
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setBarcodeTypeLengthRange = function(type, min, max, success, error) {
+  exec(success, error, barkoderScanner, "setBarcodeTypeLengthRange", [
+    type,
+    min,
+    max,
+  ]);
 };
 
-exports.setEncodingCharacterSet = function (characterSet, success, error) {
-    exec(success, error, barkoderScanner, 'setEncodingCharacterSet', [characterSet]);
+/**
+ * Sets the encoding character set for barcode scanning
+ * @param {*} characterSet - The character set to use for encoding data
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setEncodingCharacterSet = function(characterSet, success, error) {
+  exec(success, error, barkoderScanner, "setEncodingCharacterSet", [
+    characterSet,
+  ]);
 };
 
-exports.setDecodingSpeed = function (decodingSpeed, success, error) {
-    exec(success, error, barkoderScanner, 'setDecodingSpeed', [decodingSpeed]);
+/**
+ * Sets the decoding speed for barcode scanning
+ * @param {*} decodingSpeed - The decoding speed to set for the barcode scanner
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setDecodingSpeed = function(decodingSpeed, success, error) {
+  exec(success, error, barkoderScanner, "setDecodingSpeed", [decodingSpeed]);
 };
 
-exports.setFormattingType = function (formattingType, success, error) {
-    exec(success, error, barkoderScanner, 'setFormattingType', [formattingType]);
+/**
+ * Sets the formatting type for barcode scanning
+ * @param {*} formattingType - The formatting type to set for the barcode scanner
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setFormattingType = function(formattingType, success, error) {
+  exec(success, error, barkoderScanner, "setFormattingType", [formattingType]);
 };
 
-exports.setCode11ChecksumType = function (checksumType, success, error) {
-    exec(success, error, barkoderScanner, 'setCode11ChecksumType', [checksumType]);
+/**
+ * Sets the Code11 checksum type
+ * @param {*} checksumType - The checksum type to set for Code 11 barcodes
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setCode11ChecksumType = function(checksumType, success, error) {
+  exec(success, error, barkoderScanner, "setCode11ChecksumType", [
+    checksumType,
+  ]);
 };
 
-exports.setMsiChecksumType = function (checksumType, success, error) {
-    exec(success, error, barkoderScanner, 'setMsiChecksumType', [checksumType]);
+/**
+ * Sets the MSI checksum type
+ * @param {*} checksumType - The checksum type to set for the MSI barcode scanner
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setMsiChecksumType = function(checksumType, success, error) {
+  exec(success, error, barkoderScanner, "setMsiChecksumType", [checksumType]);
 };
 
-exports.setCode39ChecksumType = function (checksumType, success, error) {
-    exec(success, error, barkoderScanner, 'setCode39ChecksumType', [checksumType]);
+/**
+ * Sets the Code39 checksum type
+ * @param {*} checksumType - The checksum type to set for Code 39 barcodes
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setCode39ChecksumType = function(checksumType, success, error) {
+  exec(success, error, barkoderScanner, "setCode39ChecksumType", [
+    checksumType,
+  ]);
 };
 
-exports.setBarcodeTypeEnabled = function (type, enabled, success, error) {
-    exec(success, error, barkoderScanner, 'setBarcodeTypeEnabled', [type, enabled]);
+/**
+ * Sets whether a specific barcode type is enabled
+ * @param {*} type - The barcode type to enable or disable
+ * @param {*} enabled - Set to true to enable the barcode type, false to disable it
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setBarcodeTypeEnabled = function(type, enabled, success, error) {
+  exec(success, error, barkoderScanner, "setBarcodeTypeEnabled", [
+    type,
+    enabled,
+  ]);
 };
 
-exports.setMulticodeCachingEnabled = function (enabled, success, error) {
-    exec(success, error, barkoderScanner, 'setMulticodeCachingEnabled', [enabled]);
+/**
+ * Sets whether multi-code caching is enabled
+ * @param {*} enabled - Set to true to enable multi-code caching, false to disable it
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setMulticodeCachingEnabled = function(enabled, success, error) {
+  exec(success, error, barkoderScanner, "setMulticodeCachingEnabled", [
+    enabled,
+  ]);
 };
 
-exports.setMulticodeCachingDuration = function (duration, success, error) {
-    exec(success, error, barkoderScanner, 'setMulticodeCachingDuration', [duration]);
+/**
+ * Sets the caching duration (in milliseconds) for multi-code results
+ * @param {*} duration - The caching duration in milliseconds for multi-code barcode scanning
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setMulticodeCachingDuration = function(duration, success, error) {
+  exec(success, error, barkoderScanner, "setMulticodeCachingDuration", [
+    duration,
+  ]);
 };
 
-exports.setMaximumResultsCount = function (resultsCount, success, error) {
-    exec(success, error, barkoderScanner, 'setMaximumResultsCount', [resultsCount]);
+/**
+ * Sets the maximum number of results to be returned from barcode scanning
+ * @param {*} resultsCount - The maximum number of results to return
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setMaximumResultsCount = function(resultsCount, success, error) {
+  exec(success, error, barkoderScanner, "setMaximumResultsCount", [
+    resultsCount,
+  ]);
 };
 
-exports.setBarcodeThumbnailOnResultEnabled = function (enabled, success, error) {
-    exec(success, error, barkoderScanner, 'setBarcodeThumbnailOnResultEnabled', [enabled]);
+/**
+ * A boolean indicating whether to enable barcode thumbnail on result.
+ * @param {*} enabled - Set to true to include the barcode thumbnail in the result, false to exclude it
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setBarcodeThumbnailOnResultEnabled = function(enabled, success, error) {
+  exec(success, error, barkoderScanner, "setBarcodeThumbnailOnResultEnabled", [
+    enabled,
+  ]);
 };
 
-exports.setDuplicatesDelayMs = function (delayMs, success, error) {
-    exec(success, error, barkoderScanner, 'setDuplicatesDelayMs', [delayMs]);
+/**
+ * Sets the delay in milliseconds for considering duplicate barcodes during scanning
+ * @param {*} delayMs - The delay in milliseconds between duplicate scans
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setDuplicatesDelayMs = function(delayMs, success, error) {
+  exec(success, error, barkoderScanner, "setDuplicatesDelayMs", [delayMs]);
 };
 
-exports.setThresholdBetweenDuplicatesScans = function (thresholdBetweenDuplicatesScans, success, error) {
-    exec(success, error, barkoderScanner, 'setThresholdBetweenDuplicatesScans', [thresholdBetweenDuplicatesScans]);
+/**
+ * Sets the threshold between duplicate scans
+ * @param {*} thresholdBetweenDuplicatesScans - The threshold between duplicate scans
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setThresholdBetweenDuplicatesScans = function(
+  thresholdBetweenDuplicatesScans,
+  success,
+  error
+) {
+  exec(success, error, barkoderScanner, "setThresholdBetweenDuplicatesScans", [
+    thresholdBetweenDuplicatesScans,
+  ]);
 };
 
-exports.setUpcEanDeblurEnabled = function (enabled, success, error) {
-    exec(success, error, barkoderScanner, 'setUpcEanDeblurEnabled', [enabled]);
+/**
+ * Sets whether the deblurring feature for UPC/EAN barcodes is enabled
+ * @param {*} enabled - Set to true to enable UPC/EAN deblur, false to disable it
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setUpcEanDeblurEnabled = function(enabled, success, error) {
+  exec(success, error, barkoderScanner, "setUpcEanDeblurEnabled", [enabled]);
 };
 
-exports.setMisshaped1DEnabled = function (enabled, success, error) {
-    exec(success, error, barkoderScanner, 'setMisshaped1DEnabled', [enabled]);
+/**
+ * Sets whether the detection of misshaped 1D barcodes is enabled
+ * @param {*} enabled - Set to true to enable detection of misshaped 1D barcodes, false to disable it
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setMisshaped1DEnabled = function(enabled, success, error) {
+  exec(success, error, barkoderScanner, "setMisshaped1DEnabled", [enabled]);
 };
 
-exports.setEnableVINRestrictions = function (enableVINRestrictions, success, error) {
-    exec(success, error, barkoderScanner, 'setEnableVINRestrictions', [enableVINRestrictions]);
+/**
+ * Sets whether Vehicle Identification Number (VIN) restrictions are enabled
+ * @param {*} enableVINRestrictions - Set to true to enable VIN restrictions, false to disable them
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setEnableVINRestrictions = function(
+  enableVINRestrictions,
+  success,
+  error
+) {
+  exec(success, error, barkoderScanner, "setEnableVINRestrictions", [
+    enableVINRestrictions,
+  ]);
 };
 
-exports.setDataMatrixDpmModeEnabled = function (enabled, success, error) {
-    exec(success, error, barkoderScanner, 'setDataMatrixDpmModeEnabled', [enabled]);
+/**
+ * Sets whether the Direct Part Marking (DPM) mode for Datamatrix barcodes is enabled.
+ * @param {*} enabled - Set to true to enable Data Matrix DPM mode, false to disable it
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.setDataMatrixDpmModeEnabled = function(enabled, success, error) {
+  exec(success, error, barkoderScanner, "setDataMatrixDpmModeEnabled", [
+    enabled,
+  ]);
 };
 
-exports.configureBarkoder = function (barkoderConfig, success, error) {
-    exec(success, error, barkoderScanner, 'configureBarkoder', [barkoderConfig]);
+/**
+ * Configures the Barkoder functionality based on the provided configuration
+ * @param {*} barkoderConfig - The configuration object for Barkoder scanner
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.configureBarkoder = function(barkoderConfig, success, error) {
+  exec(success, error, barkoderScanner, "configureBarkoder", [barkoderConfig]);
 };
 
-  // - Getters
+// - Getters
 
-exports.isFlashAvailable = function (success, error) {
-    exec(success, error, barkoderScanner, 'isFlashAvailable', []);
+/**
+ * Checks whether the device has a built-in flash (torch) that can be used for illumination during barcode scanning
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.isFlashAvailable = function(success, error) {
+  exec(success, error, barkoderScanner, "isFlashAvailable", []);
 };
 
-exports.isCloseSessionOnResultEnabled = function (success, error) {
-    exec(success, error, barkoderScanner, 'isCloseSessionOnResultEnabled', []);
+exports.isCloseSessionOnResultEnabled = function(success, error) {
+  exec(success, error, barkoderScanner, "isCloseSessionOnResultEnabled", []);
 };
 
-exports.isImageResultEnabled = function (success, error) {
-    exec(success, error, barkoderScanner, 'isImageResultEnabled', []);
+/**
+ * Enables or disables the capturing and processing of image data when a barcode is successfully detected
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.isImageResultEnabled = function(success, error) {
+  exec(success, error, barkoderScanner, "isImageResultEnabled", []);
 };
 
-exports.isLocationInImageResultEnabled = function (success, error) {
-    exec(success, error, barkoderScanner, 'isLocationInImageResultEnabled', []);
+exports.isLocationInImageResultEnabled = function(success, error) {
+  exec(success, error, barkoderScanner, "isLocationInImageResultEnabled", []);
 };
 
-exports.isLocationInPreviewEnabled = function (success, error) {
-    exec(success, error, barkoderScanner, 'isLocationInPreviewEnabled', []);
+/**
+ * Checks if location in preview is enabled
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.isLocationInPreviewEnabled = function(success, error) {
+  exec(success, error, barkoderScanner, "isLocationInPreviewEnabled", []);
 };
 
-exports.isPinchToZoomEnabled = function (success, error) {
-    exec(success, error, barkoderScanner, 'isPinchToZoomEnabled', []);
+/**
+ * Checks if pinch to zoom is enabled
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.isPinchToZoomEnabled = function(success, error) {
+  exec(success, error, barkoderScanner, "isPinchToZoomEnabled", []);
 };
 
-exports.isRegionOfInterestVisible = function (success, error) {
-    exec(success, error, barkoderScanner, 'isRegionOfInterestVisible', []);
+/**
+ * Checks if the region of interest (ROI) is visible
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.isRegionOfInterestVisible = function(success, error) {
+  exec(success, error, barkoderScanner, "isRegionOfInterestVisible", []);
 };
 
-exports.isBeepOnSuccessEnabled = function (success, error) {
-    exec(success, error, barkoderScanner, 'isBeepOnSuccessEnabled', []);
+/**
+ * Retrieves the value indicating whether a beep sound is played on successful barcode scanning
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.isBeepOnSuccessEnabled = function(success, error) {
+  exec(success, error, barkoderScanner, "isBeepOnSuccessEnabled", []);
 };
 
-exports.isVibrateOnSuccessEnabled = function (success, error) {
-    exec(success, error, barkoderScanner, 'isVibrateOnSuccessEnabled', []);
+/**
+ * Retrieves the value indicating whether vibration is enabled on successful barcode scanning
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.isVibrateOnSuccessEnabled = function(success, error) {
+  exec(success, error, barkoderScanner, "isVibrateOnSuccessEnabled", []);
 };
 
-exports.getVersion = function (success, error) {
-    exec(success, error, barkoderScanner, 'getVersion', []);
+/**
+ * Retrieves the version of the Barkoder library
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getVersion = function(success, error) {
+  exec(success, error, barkoderScanner, "getVersion", []);
 };
 
-exports.getLocationLineColorHex = function (success, error) {
-    exec(success, error, barkoderScanner, 'getLocationLineColorHex', []);
+/**
+ * Retrieves the hexadecimal color code representing the line color used to indicate the location of detected barcodes
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getLocationLineColorHex = function(success, error) {
+  exec(success, error, barkoderScanner, "getLocationLineColorHex", []);
 };
 
-exports.getRoiLineColorHex = function (success, error) {
-    exec(success, error, barkoderScanner, 'getRoiLineColorHex', []);
+/**
+ * Retrieves the hexadecimal color code representing the line color of the Region of Interest (ROI) on the camera preview
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getRoiLineColorHex = function(success, error) {
+  exec(success, error, barkoderScanner, "getRoiLineColorHex", []);
 };
 
-exports.getRoiOverlayBackgroundColorHex = function (success, error) {
-    exec(success, error, barkoderScanner, 'getRoiOverlayBackgroundColorHex', []);
+/**
+ * Retrieves the hexadecimal color code representing the background color of the overlay within the Region of Interest (ROI) on the camera preview
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getRoiOverlayBackgroundColorHex = function(success, error) {
+  exec(success, error, barkoderScanner, "getRoiOverlayBackgroundColorHex", []);
 };
 
-exports.getMaxZoomFactor = function (success, error) {
-    exec(success, error, barkoderScanner, 'getMaxZoomFactor', []);
+/**
+ * Retrieves the maximum available zoom factor for the device's camera
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getMaxZoomFactor = function(success, error) {
+  exec(success, error, barkoderScanner, "getMaxZoomFactor", []);
 };
 
-exports.getLocationLineWidth = function (success, error) {
-    exec(success, error, barkoderScanner, 'getLocationLineWidth', []);
+/**
+ * Retrieves the current width setting for the lines indicating the location of detected barcodes on the camera feed
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getLocationLineWidth = function(success, error) {
+  exec(success, error, barkoderScanner, "getLocationLineWidth", []);
 };
 
-exports.getRoiLineWidth = function (success, error) {
-    exec(success, error, barkoderScanner, 'getRoiLineWidth', []);
+/**
+ * Retrieves the current width setting for the lines outlining the Region of Interest (ROI) on the camera preview
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getRoiLineWidth = function(success, error) {
+  exec(success, error, barkoderScanner, "getRoiLineWidth", []);
 };
 
-exports.getRegionOfInterest = function (success, error) {
-    exec(success, error, barkoderScanner, 'getRegionOfInterest', []);
+/**
+ * Retrieves the region of interest (ROI)
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getRegionOfInterest = function(success, error) {
+  exec(success, error, barkoderScanner, "getRegionOfInterest", []);
 };
 
-exports.getBarcodeTypeLengthRange = function (type, success, error) {
-    exec(success, error, barkoderScanner, 'getBarcodeTypeLengthRange', [type]);
+/**
+ * Retrieves the length range of a specific barcode type
+ * @param {*} type - The barcode type to check
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getBarcodeTypeLengthRange = function(type, success, error) {
+  exec(success, error, barkoderScanner, "getBarcodeTypeLengthRange", [type]);
 };
 
-exports.getMsiChecksumType = function (success, error) {
-    exec(success, error, barkoderScanner, 'getMsiChecksumType', []);
+/**
+ * Retrieves the MSI checksum type
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getMsiChecksumType = function(success, error) {
+  exec(success, error, barkoderScanner, "getMsiChecksumType", []);
 };
 
-exports.getCode39ChecksumType = function (success, error) {
-    exec(success, error, barkoderScanner, 'getCode39ChecksumType', []);
+/**
+ * Retrieves the checksum type for Code 39 barcodes
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getCode39ChecksumType = function(success, error) {
+  exec(success, error, barkoderScanner, "getCode39ChecksumType", []);
 };
 
-exports.getCode11ChecksumType = function (success, error) {
-    exec(success, error, barkoderScanner, 'getCode11ChecksumType', []);
+/**
+ * Retrieves the Code11 checksum type
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getCode11ChecksumType = function(success, error) {
+  exec(success, error, barkoderScanner, "getCode11ChecksumType", []);
 };
 
-exports.getEncodingCharacterSet = function (success, error) {
-    exec(success, error, barkoderScanner, 'getEncodingCharacterSet', []);
+/**
+ * Retrieves the character set used for encoding barcode data
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getEncodingCharacterSet = function(success, error) {
+  exec(success, error, barkoderScanner, "getEncodingCharacterSet", []);
 };
 
-exports.getDecodingSpeed = function (success, error) {
-    exec(success, error, barkoderScanner, 'getDecodingSpeed', []);
+/**
+ * Retrieves the current decoding speed setting for barcode scanning
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getDecodingSpeed = function(success, error) {
+  exec(success, error, barkoderScanner, "getDecodingSpeed", []);
 };
 
-exports.getFormattingType = function (success, error) {
-    exec(success, error, barkoderScanner, 'getFormattingType', []);
+/**
+ * Retrieves the formatting type used for presenting decoded barcode data.
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getFormattingType = function(success, error) {
+  exec(success, error, barkoderScanner, "getFormattingType", []);
 };
 
-exports.getThreadsLimit = function (success, error) {
-    exec(success, error, barkoderScanner, 'getThreadsLimit', []);
+/**
+ * Retrieves the threads limit
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getThreadsLimit = function(success, error) {
+  exec(success, error, barkoderScanner, "getThreadsLimit", []);
 };
 
-exports.getMaximumResultsCount = function (success, error) {
-    exec(success, error, barkoderScanner, 'getMaximumResultsCount', []);
+/**
+ * Retrieves the maximum number of results to be returned from barcode scanning at once
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getMaximumResultsCount = function(success, error) {
+  exec(success, error, barkoderScanner, "getMaximumResultsCount", []);
 };
 
-exports.getDuplicatesDelayMs = function (success, error) {
-    exec(success, error, barkoderScanner, 'getDuplicatesDelayMs', []);
+/**
+ * Retrieves the delay in milliseconds for considering duplicate barcodes during scanning
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getDuplicatesDelayMs = function(success, error) {
+  exec(success, error, barkoderScanner, "getDuplicatesDelayMs", []);
 };
 
-exports.isBarcodeTypeEnabled = function (type, success, error) {
-    exec(success, error, barkoderScanner, 'isBarcodeTypeEnabled', [type]);
+/**
+ * Checks if a specific barcode type is enabled
+ * @param {*} type - The barcode type to check
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.isBarcodeTypeEnabled = function(type, success, error) {
+  exec(success, error, barkoderScanner, "isBarcodeTypeEnabled", [type]);
 };
 
-exports.getMulticodeCachingEnabled = function (success, error) {
-    exec(success, error, barkoderScanner, 'getMulticodeCachingEnabled', []);
+/**
+ * Retrieves whether multi-code caching is enabled
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getMulticodeCachingEnabled = function(success, error) {
+  exec(success, error, barkoderScanner, "getMulticodeCachingEnabled", []);
 };
 
-exports.getMulticodeCachingDuration = function (success, error) {
-    exec(success, error, barkoderScanner, 'getMulticodeCachingDuration', []);
+/**
+ * Retrieves the caching duration (in milliseconds) for multi-code results
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getMulticodeCachingDuration = function(success, error) {
+  exec(success, error, barkoderScanner, "getMulticodeCachingDuration", []);
 };
 
-exports.isUpcEanDeblurEnabled = function (success, error) {
-    exec(success, error, barkoderScanner, 'isUpcEanDeblurEnabled', []);
+/**
+ * Retrieves the value indicating whether deblurring is enabled for UPC/EAN barcodes
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.isUpcEanDeblurEnabled = function(success, error) {
+  exec(success, error, barkoderScanner, "isUpcEanDeblurEnabled", []);
 };
 
-exports.isMisshaped1DEnabled = function (success, error) {
-    exec(success, error, barkoderScanner, 'isMisshaped1DEnabled', []);
+/**
+ * Checks if the detection of misshaped 1D barcodes is enabled
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.isMisshaped1DEnabled = function(success, error) {
+  exec(success, error, barkoderScanner, "isMisshaped1DEnabled", []);
 };
 
-exports.isBarcodeThumbnailOnResultEnabled = function (success, error) {
-    exec(success, error, barkoderScanner, 'isBarcodeThumbnailOnResultEnabled', []);
+/**
+ * Checks if the barcode thumbnail on result is enabled
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.isBarcodeThumbnailOnResultEnabled = function(success, error) {
+  exec(
+    success,
+    error,
+    barkoderScanner,
+    "isBarcodeThumbnailOnResultEnabled",
+    []
+  );
 };
 
-exports.getThresholdBetweenDuplicatesScans = function (success, error) {
-    exec(success, error, barkoderScanner, 'getThresholdBetweenDuplicatesScans', []);
+/**
+ * Retrieves the threshold between duplicate scans
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getThresholdBetweenDuplicatesScans = function(success, error) {
+  exec(
+    success,
+    error,
+    barkoderScanner,
+    "getThresholdBetweenDuplicatesScans",
+    []
+  );
 };
 
-exports.isVINRestrictionsEnabled = function (success, error) {
-    exec(success, error, barkoderScanner, 'isVINRestrictionsEnabled', []);
+/**
+ * Checks if VIN restrictions are enabled
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.isVINRestrictionsEnabled = function(success, error) {
+  exec(success, error, barkoderScanner, "isVINRestrictionsEnabled", []);
 };
 
-exports.getBarkoderResolution = function (success, error) {
-    exec(success, error, barkoderScanner, 'getBarkoderResolution', []);
-};
+/**
+ * Retrieves the resolution for barcode scanning
+ * @param {*} success - The callback function to be invoked on successful execution
+ * @param {*} error - The callback function to be invoked on execution error
+ */
+exports.getBarkoderResolution = function(success, error) {
+  exec(success, error, barkoderScanner, "getBarkoderResolution", []);
+};

No alert changes

Improved metrics

Total package byte prevSize

13548069

increased by0.28%

Lines of code

28910

increased by1.83%

No dependency changes