barkoder-capacitor - npm Package Compare versions

Comparing version 1.3.0 to 1.3.1

dist/docs.json

@@ -52,3 +52,3 @@ {
         "tags": [],
-        "docs": "",
+        "docs": "Sets the zoom factor for the device's camera, adjusting the level of zoom during barcode scanning",
         "complexTypes": [],
@@ -69,3 +69,3 @@ "slug": "setzoomfactor"
         "tags": [],
-        "docs": "",
+        "docs": "Enables or disables the device's flash (torch) for illumination during barcode scanning",
         "complexTypes": [],
@@ -90,3 +90,3 @@ "slug": "setflashenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Initiates the barcode scanning process, allowing the application to detect and decode barcodes from the device's camera feed",
         "complexTypes": [],
@@ -101,3 +101,3 @@ "slug": "startscanning"
         "tags": [],
-        "docs": "",
+        "docs": "Halts the barcode scanning process, stopping the camera from capturing and processing barcode information",
         "complexTypes": [],
@@ -112,3 +112,3 @@ "slug": "stopscanning"
         "tags": [],
-        "docs": "",
+        "docs": "Temporarily suspends the barcode scanning process, pausing the camera feed without completely stopping the scanning session",
         "complexTypes": [],
@@ -129,3 +129,3 @@ "slug": "pausescanning"
         "tags": [],
-        "docs": "",
+        "docs": "Sets the color of the lines used to indicate the location of detected barcodes on the camera feed",
         "complexTypes": [],
@@ -146,3 +146,3 @@ "slug": "setlocationlinecolor"
         "tags": [],
-        "docs": "",
+        "docs": "Sets the width of the lines indicating the location of detected barcodes on the camera feed",
         "complexTypes": [],
@@ -163,3 +163,3 @@ "slug": "setlocationlinewidth"
         "tags": [],
-        "docs": "",
+        "docs": "Sets the color of the lines outlining the Region of Interest (ROI) for barcode scanning on the camera feed",
         "complexTypes": [],
@@ -180,3 +180,3 @@ "slug": "setroilinecolor"
         "tags": [],
-        "docs": "",
+        "docs": "Sets the width of the lines outlining the Region of Interest (ROI) for barcode scanning on the camera feed",
         "complexTypes": [],
@@ -197,3 +197,3 @@ "slug": "setroilinewidth"
         "tags": [],
-        "docs": "",
+        "docs": "Sets the background color of the overlay within the Region of Interest (ROI) for barcode scanning on the camera feed",
         "complexTypes": [],
@@ -214,3 +214,3 @@ "slug": "setroioverlaybackgroundcolor"
         "tags": [],
-        "docs": "",
+        "docs": "Enables or disables the automatic closing of the scanning session upon detecting a barcode result",
         "complexTypes": [],
@@ -231,3 +231,3 @@ "slug": "setclosesessiononresultenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Enables or disables the capturing and processing of image data when a barcode is successfully detected",
         "complexTypes": [],
@@ -248,3 +248,3 @@ "slug": "setimageresultenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Enables or disables the inclusion of barcode location information within the image data result",
         "complexTypes": [],
@@ -265,3 +265,3 @@ "slug": "setlocationinimageresultenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Defines the Region of Interest (ROI) on the camera preview for barcode scanning, specifying an area where the application focuses on detecting barcodes",
         "complexTypes": [],
@@ -282,3 +282,3 @@ "slug": "setregionofinterest"
         "tags": [],
-        "docs": "",
+        "docs": "Sets the threads limit",
         "complexTypes": [],
@@ -299,3 +299,3 @@ "slug": "setthreadslimit"
         "tags": [],
-        "docs": "",
+        "docs": "Enables or disables the display of barcode location information on the camera preview",
         "complexTypes": [],
@@ -316,3 +316,3 @@ "slug": "setlocationinpreviewenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Enables or disables the pinch-to-zoom feature for adjusting the zoom level during barcode scanning",
         "complexTypes": [],
@@ -333,3 +333,3 @@ "slug": "setpinchtozoomenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Sets the visibility of the Region of Interest (ROI) on the camera preview",
         "complexTypes": [],
@@ -350,3 +350,3 @@ "slug": "setregionofinterestvisible"
         "tags": [],
-        "docs": "",
+        "docs": "Sets the resolution for barcode scanning",
         "complexTypes": [],
@@ -367,3 +367,3 @@ "slug": "setbarkoderresolution"
         "tags": [],
-        "docs": "",
+        "docs": "Enables or disables the audible beep sound upon successfully decoding a barcode",
         "complexTypes": [],
@@ -384,3 +384,3 @@ "slug": "setbeeponsuccessenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Enables or disables the device vibration upon successfully decoding a barcode.",
         "complexTypes": [],
@@ -417,3 +417,3 @@ "slug": "setvibrateonsuccessenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Sets the length range for the specified barcode type",
         "complexTypes": [],
@@ -434,3 +434,3 @@ "slug": "setbarcodetypelengthrange"
         "tags": [],
-        "docs": "",
+        "docs": "Sets the encoding character set for barcode scanning",
         "complexTypes": [],
@@ -451,3 +451,3 @@ "slug": "setencodingcharacterset"
         "tags": [],
-        "docs": "",
+        "docs": "Sets the decoding speed for barcode scanning",
         "complexTypes": [],
@@ -468,3 +468,3 @@ "slug": "setdecodingspeed"
         "tags": [],
-        "docs": "",
+        "docs": "Sets the formatting type for barcode scanning",
         "complexTypes": [],
@@ -485,3 +485,3 @@ "slug": "setformattingtype"
         "tags": [],
-        "docs": "",
+        "docs": "Sets the Code11 checksum type",
         "complexTypes": [],
@@ -502,3 +502,3 @@ "slug": "setcode11checksumtype"
         "tags": [],
-        "docs": "",
+        "docs": "Sets the MSI checksum type",
         "complexTypes": [],
@@ -519,3 +519,3 @@ "slug": "setmsichecksumtype"
         "tags": [],
-        "docs": "",
+        "docs": "Sets the Code39 checksum type",
         "complexTypes": [],
@@ -536,3 +536,3 @@ "slug": "setcode39checksumtype"
         "tags": [],
-        "docs": "",
+        "docs": "Sets whether a specific barcode type is enabled",
         "complexTypes": [],
@@ -553,3 +553,3 @@ "slug": "setbarcodetypeenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Sets whether multi-code caching is enabled",
         "complexTypes": [],
@@ -570,3 +570,3 @@ "slug": "setmulticodecachingenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Sets the caching duration (in milliseconds) for multi-code results",
         "complexTypes": [],
@@ -587,3 +587,3 @@ "slug": "setmulticodecachingduration"
         "tags": [],
-        "docs": "",
+        "docs": "Sets the maximum number of results to be returned from barcode scanning",
         "complexTypes": [],
@@ -604,3 +604,3 @@ "slug": "setmaximumresultscount"
         "tags": [],
-        "docs": "",
+        "docs": "A boolean indicating whether to enable barcode thumbnail on result.",
         "complexTypes": [],
@@ -621,3 +621,3 @@ "slug": "setbarcodethumbnailonresultenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Sets the delay in milliseconds for considering duplicate barcodes during scanning",
         "complexTypes": [],
@@ -638,3 +638,3 @@ "slug": "setduplicatesdelayms"
         "tags": [],
-        "docs": "",
+        "docs": "Sets the threshold between duplicate scans",
         "complexTypes": [],
@@ -655,3 +655,3 @@ "slug": "setthresholdbetweenduplicatesscans"
         "tags": [],
-        "docs": "",
+        "docs": "Sets whether the deblurring feature for UPC/EAN barcodes is enabled",
         "complexTypes": [],
@@ -672,3 +672,3 @@ "slug": "setupceandeblurenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Sets whether the detection of misshaped 1D barcodes is enabled",
         "complexTypes": [],
@@ -689,3 +689,3 @@ "slug": "setmisshaped1denabled"
         "tags": [],
-        "docs": "",
+        "docs": "Sets whether Vehicle Identification Number (VIN) restrictions are enabled",
         "complexTypes": [],
@@ -706,3 +706,3 @@ "slug": "setenablevinrestrictions"
         "tags": [],
-        "docs": "",
+        "docs": "Sets whether the Direct Part Marking (DPM) mode for Datamatrix barcodes is enabled.",
         "complexTypes": [],
@@ -723,3 +723,3 @@ "slug": "setdatamatrixdpmmodeenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Configures the Barkoder functionality based on the provided configuration",
         "complexTypes": [
@@ -736,3 +736,3 @@ "BarkoderConfig"
         "tags": [],
-        "docs": "",
+        "docs": "Checks whether the device has a built-in flash (torch) that can be used for illumination during barcode scanning",
         "complexTypes": [],
@@ -747,3 +747,3 @@ "slug": "isflashavailable"
         "tags": [],
-        "docs": "",
+        "docs": "Enables or disables the automatic closing of the scanning session upon detecting a barcode result",
         "complexTypes": [],
@@ -758,3 +758,3 @@ "slug": "isclosesessiononresultenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Enables or disables the capturing and processing of image data when a barcode is successfully detected",
         "complexTypes": [],
@@ -769,3 +769,3 @@ "slug": "isimageresultenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Enables or disables the inclusion of barcode location information within the image data result",
         "complexTypes": [],
@@ -780,3 +780,3 @@ "slug": "islocationinimageresultenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Checks if location in preview is enabled",
         "complexTypes": [],
@@ -791,3 +791,3 @@ "slug": "islocationinpreviewenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Checks if pinch to zoom is enabled",
         "complexTypes": [],
@@ -802,3 +802,3 @@ "slug": "ispinchtozoomenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Checks if the region of interest (ROI) is visible",
         "complexTypes": [],
@@ -813,3 +813,3 @@ "slug": "isregionofinterestvisible"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the value indicating whether a beep sound is played on successful barcode scanning",
         "complexTypes": [],
@@ -824,3 +824,3 @@ "slug": "isbeeponsuccessenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the value indicating whether vibration is enabled on successful barcode scanning",
         "complexTypes": [],
@@ -835,3 +835,3 @@ "slug": "isvibrateonsuccessenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the version of the Barkoder library",
         "complexTypes": [],
@@ -846,3 +846,3 @@ "slug": "getversion"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the hexadecimal color code representing the line color used to indicate the location of detected barcodes",
         "complexTypes": [],
@@ -857,3 +857,3 @@ "slug": "getlocationlinecolorhex"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the hexadecimal color code representing the line color of the Region of Interest (ROI) on the camera preview",
         "complexTypes": [],
@@ -868,3 +868,3 @@ "slug": "getroilinecolorhex"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the hexadecimal color code representing the background color of the overlay within the Region of Interest (ROI) on the camera preview",
         "complexTypes": [],
@@ -879,3 +879,3 @@ "slug": "getroioverlaybackgroundcolorhex"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the maximum available zoom factor for the device's camera",
         "complexTypes": [],
@@ -890,3 +890,3 @@ "slug": "getmaxzoomfactor"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the current width setting for the lines indicating the location of detected barcodes on the camera feed",
         "complexTypes": [],
@@ -901,3 +901,3 @@ "slug": "getlocationlinewidth"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the current width setting for the lines outlining the Region of Interest (ROI) on the camera preview",
         "complexTypes": [],
@@ -912,3 +912,3 @@ "slug": "getroilinewidth"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the region of interest (ROI)",
         "complexTypes": [],
@@ -929,3 +929,3 @@ "slug": "getregionofinterest"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the length range of a specific barcode type",
         "complexTypes": [],
@@ -940,3 +940,3 @@ "slug": "getbarcodetypelengthrange"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the MSI checksum type",
         "complexTypes": [],
@@ -951,3 +951,3 @@ "slug": "getmsichecksumtype"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the checksum type for Code 39 barcodes",
         "complexTypes": [],
@@ -962,3 +962,3 @@ "slug": "getcode39checksumtype"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the Code11 checksum type",
         "complexTypes": [],
@@ -973,3 +973,3 @@ "slug": "getcode11checksumtype"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the character set used for encoding barcode data",
         "complexTypes": [],
@@ -984,3 +984,3 @@ "slug": "getencodingcharacterset"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the current decoding speed setting for barcode scanning",
         "complexTypes": [],
@@ -995,3 +995,3 @@ "slug": "getdecodingspeed"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the formatting type used for presenting decoded barcode data.",
         "complexTypes": [],
@@ -1006,3 +1006,3 @@ "slug": "getformattingtype"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the threads limit",
         "complexTypes": [],
@@ -1017,3 +1017,3 @@ "slug": "getthreadslimit"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the maximum number of results to be returned from barcode scanning at once",
         "complexTypes": [],
@@ -1028,3 +1028,3 @@ "slug": "getmaximumresultscount"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the delay in milliseconds for considering duplicate barcodes during scanning",
         "complexTypes": [],
@@ -1045,3 +1045,3 @@ "slug": "getduplicatesdelayms"
         "tags": [],
-        "docs": "",
+        "docs": "Checks if a specific barcode type is enabled",
         "complexTypes": [],
@@ -1056,3 +1056,3 @@ "slug": "isbarcodetypeenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves whether multi-code caching is enabled",
         "complexTypes": [],
@@ -1067,3 +1067,3 @@ "slug": "getmulticodecachingenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the caching duration (in milliseconds) for multi-code results",
         "complexTypes": [],
@@ -1078,3 +1078,3 @@ "slug": "getmulticodecachingduration"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the value indicating whether deblurring is enabled for UPC/EAN barcodes",
         "complexTypes": [],
@@ -1089,3 +1089,3 @@ "slug": "isupceandeblurenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Checks if the detection of misshaped 1D barcodes is enabled",
         "complexTypes": [],
@@ -1100,3 +1100,3 @@ "slug": "ismisshaped1denabled"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieve whether to enable barcode thumbnail on result",
         "complexTypes": [],
@@ -1111,3 +1111,3 @@ "slug": "isbarcodethumbnailonresultenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the threshold between duplicate scans",
         "complexTypes": [],
@@ -1122,3 +1122,3 @@ "slug": "getthresholdbetweenduplicatesscans"
         "tags": [],
-        "docs": "",
+        "docs": "Checks if VIN restrictions are enabled",
         "complexTypes": [],
@@ -1133,3 +1133,3 @@ "slug": "isvinrestrictionsenabled"
         "tags": [],
-        "docs": "",
+        "docs": "Retrieves the resolution for barcode scanning",
         "complexTypes": [],
@@ -1136,0 +1136,0 @@ "slug": "getbarkoderresolution"

dist/esm/definitions.d.ts

@@ -12,5 +12,11 @@ import { Plugin } from '@capacitor/core';
     }): Promise<any>;
+    /**
+     * Sets the zoom factor for the device's camera, adjusting the level of zoom during barcode scanning
+     */
     setZoomFactor(options: {
         value: number;
     }): Promise<any>;
+    /**
+     * Enables or disables the device's flash (torch) for illumination during barcode scanning
+     */
     setFlashEnabled(options: {
@@ -20,29 +26,65 @@ enabled: boolean;
     startCamera(): Promise<any>;
+    /**
+     * Initiates the barcode scanning process, allowing the application to detect and decode barcodes from the device's camera feed
+     */
     startScanning(): Promise<any>;
+    /**
+     * Halts the barcode scanning process, stopping the camera from capturing and processing barcode information
+     */
     stopScanning(): Promise<any>;
+    /**
+     * Temporarily suspends the barcode scanning process, pausing the camera feed without completely stopping the scanning session
+     */
     pauseScanning(): Promise<any>;
+    /**
+     * Sets the color of the lines used to indicate the location of detected barcodes on the camera feed
+     */
     setLocationLineColor(options: {
         value: string;
     }): Promise<any>;
+    /**
+     * Sets the width of the lines indicating the location of detected barcodes on the camera feed
+     */
     setLocationLineWidth(options: {
         value: number;
     }): Promise<any>;
+    /**
+     * Sets the color of the lines outlining the Region of Interest (ROI) for barcode scanning on the camera feed
+     */
     setRoiLineColor(options: {
         value: string;
     }): Promise<any>;
+    /**
+     * Sets the width of the lines outlining the Region of Interest (ROI) for barcode scanning on the camera feed
+     */
     setRoiLineWidth(options: {
         value: number;
     }): Promise<any>;
+    /**
+     * Sets the background color of the overlay within the Region of Interest (ROI) for barcode scanning on the camera feed
+     */
     setRoiOverlayBackgroundColor(options: {
         value: string;
     }): Promise<any>;
+    /**
+     * Enables or disables the automatic closing of the scanning session upon detecting a barcode result
+     */
     setCloseSessionOnResultEnabled(options: {
         enabled: boolean;
     }): Promise<any>;
+    /**
+     * Enables or disables the capturing and processing of image data when a barcode is successfully detected
+     */
     setImageResultEnabled(options: {
         enabled: boolean;
     }): Promise<any>;
+    /**
+     * Enables or disables the inclusion of barcode location information within the image data result
+     */
     setLocationInImageResultEnabled(options: {
         enabled: boolean;
     }): Promise<any>;
+    /**
+     * Defines the Region of Interest (ROI) on the camera preview for barcode scanning, specifying an area where the application focuses on detecting barcodes
+     */
     setRegionOfInterest(options: {
@@ -54,20 +96,41 @@ left: number;
     }): Promise<any>;
+    /**
+     * Sets the threads limit
+     */
     setThreadsLimit(options: {
         value: number;
     }): Promise<any>;
+    /**
+     * Enables or disables the display of barcode location information on the camera preview
+     */
     setLocationInPreviewEnabled(options: {
         enabled: boolean;
     }): Promise<any>;
+    /**
+     * Enables or disables the pinch-to-zoom feature for adjusting the zoom level during barcode scanning
+     */
     setPinchToZoomEnabled(options: {
         enabled: boolean;
     }): Promise<any>;
+    /**
+     * Sets the visibility of the Region of Interest (ROI) on the camera preview
+     */
     setRegionOfInterestVisible(options: {
         value: boolean;
     }): Promise<any>;
+    /**
+     * Sets the resolution for barcode scanning
+     */
     setBarkoderResolution(options: {
         value: number;
     }): Promise<any>;
+    /**
+     * Enables or disables the audible beep sound upon successfully decoding a barcode
+     */
     setBeepOnSuccessEnabled(options: {
         enabled: boolean;
     }): Promise<any>;
+    /**
+     * Enables or disables the device vibration upon successfully decoding a barcode.
+     */
     setVibrateOnSuccessEnabled(options: {
@@ -79,2 +142,5 @@ enabled: boolean;
     }): Promise<any>;
+    /**
+     * Sets the length range for the specified barcode type
+     */
     setBarcodeTypeLengthRange(options: {
@@ -85,20 +151,41 @@ type: number;
     }): Promise<any>;
+    /**
+     * Sets the encoding character set for barcode scanning
+     */
     setEncodingCharacterSet(options: {
         value: string;
     }): Promise<any>;
+    /**
+     * Sets the decoding speed for barcode scanning
+     */
     setDecodingSpeed(options: {
         value: number;
     }): Promise<any>;
+    /**
+     * Sets the formatting type for barcode scanning
+     */
     setFormattingType(options: {
         value: number;
     }): Promise<any>;
+    /**
+     * Sets the Code11 checksum type
+     */
     setCode11ChecksumType(options: {
         value: number;
     }): Promise<any>;
+    /**
+     * Sets the MSI checksum type
+     */
     setMsiChecksumType(options: {
         value: number;
     }): Promise<any>;
+    /**
+     * Sets the Code39 checksum type
+     */
     setCode39ChecksumType(options: {
         value: number;
     }): Promise<any>;
+    /**
+     * Sets whether a specific barcode type is enabled
+     */
     setBarcodeTypeEnabled(options: {
@@ -108,74 +195,215 @@ type: number;
     }): Promise<any>;
+    /**
+     * Sets whether multi-code caching is enabled
+     */
     setMulticodeCachingEnabled(options: {
         enabled: boolean;
     }): Promise<any>;
+    /**
+     * Sets the caching duration (in milliseconds) for multi-code results
+     */
     setMulticodeCachingDuration(options: {
         value: number;
     }): Promise<any>;
+    /**
+     * Sets the maximum number of results to be returned from barcode scanning
+     */
     setMaximumResultsCount(options: {
         value: number;
     }): Promise<any>;
+    /**
+     * A boolean indicating whether to enable barcode thumbnail on result.
+     */
     setBarcodeThumbnailOnResultEnabled(options: {
         enabled: boolean;
     }): Promise<any>;
+    /**
+     * Sets the delay in milliseconds for considering duplicate barcodes during scanning
+     */
     setDuplicatesDelayMs(options: {
         value: number;
     }): Promise<any>;
+    /**
+     * Sets the threshold between duplicate scans
+     */
     setThresholdBetweenDuplicatesScans(options: {
         value: number;
     }): Promise<any>;
+    /**
+     * Sets whether the deblurring feature for UPC/EAN barcodes is enabled
+     */
     setUpcEanDeblurEnabled(options: {
         enabled: boolean;
     }): Promise<any>;
+    /**
+     * Sets whether the detection of misshaped 1D barcodes is enabled
+     */
     setMisshaped1DEnabled(options: {
         enabled: boolean;
     }): Promise<any>;
+    /**
+     * Sets whether Vehicle Identification Number (VIN) restrictions are enabled
+     */
     setEnableVINRestrictions(options: {
         value: boolean;
     }): Promise<any>;
+    /**
+     * Sets whether the Direct Part Marking (DPM) mode for Datamatrix barcodes is enabled.
+     */
     setDatamatrixDpmModeEnabled(options: {
         enabled: boolean;
     }): Promise<any>;
+    /**
+     * Configures the Barkoder functionality based on the provided configuration
+     */
     configureBarkoder(options: {
         barkoderConfig: BarkoderConfig;
     }): Promise<any>;
+    /**
+     * Checks whether the device has a built-in flash (torch) that can be used for illumination during barcode scanning
+     */
     isFlashAvailable(): Promise<any>;
+    /**
+     * Enables or disables the automatic closing of the scanning session upon detecting a barcode result
+     */
     isCloseSessionOnResultEnabled(): Promise<any>;
+    /**
+     * Enables or disables the capturing and processing of image data when a barcode is successfully detected
+     */
     isImageResultEnabled(): Promise<any>;
+    /**
+     * Enables or disables the inclusion of barcode location information within the image data result
+     */
     isLocationInImageResultEnabled(): Promise<any>;
+    /**
+     * Checks if location in preview is enabled
+     */
     isLocationInPreviewEnabled(): Promise<any>;
+    /**
+     * Checks if pinch to zoom is enabled
+     */
     isPinchToZoomEnabled(): Promise<any>;
+    /**
+     * Checks if the region of interest (ROI) is visible
+     */
     isRegionOfInterestVisible(): Promise<any>;
+    /**
+     * Retrieves the value indicating whether a beep sound is played on successful barcode scanning
+     */
     isBeepOnSuccessEnabled(): Promise<any>;
+    /**
+     * Retrieves the value indicating whether vibration is enabled on successful barcode scanning
+     */
     isVibrateOnSuccessEnabled(): Promise<any>;
+    /**
+     * Retrieves the version of the Barkoder library
+     */
     getVersion(): Promise<any>;
+    /**
+     * Retrieves the hexadecimal color code representing the line color used to indicate the location of detected barcodes
+     */
     getLocationLineColorHex(): Promise<any>;
+    /**
+     * Retrieves the hexadecimal color code representing the line color of the Region of Interest (ROI) on the camera preview
+     */
     getRoiLineColorHex(): Promise<any>;
+    /**
+     * Retrieves the hexadecimal color code representing the background color of the overlay within the Region of Interest (ROI) on the camera preview
+     */
     getRoiOverlayBackgroundColorHex(): Promise<any>;
+    /**
+     * Retrieves the maximum available zoom factor for the device's camera
+     */
     getMaxZoomFactor(): Promise<any>;
+    /**
+     * Retrieves the current width setting for the lines indicating the location of detected barcodes on the camera feed
+     */
     getLocationLineWidth(): Promise<any>;
+    /**
+     * Retrieves the current width setting for the lines outlining the Region of Interest (ROI) on the camera preview
+     */
     getRoiLineWidth(): Promise<any>;
+    /**
+     * Retrieves the region of interest (ROI)
+     */
     getRegionOfInterest(): Promise<any>;
+    /**
+     * Retrieves the length range of a specific barcode type
+     */
     getBarcodeTypeLengthRange(options: {
         type: number;
     }): Promise<any>;
+    /**
+     * Retrieves the MSI checksum type
+     */
     getMsiChecksumType(): Promise<any>;
+    /**
+     * Retrieves the checksum type for Code 39 barcodes
+     */
     getCode39ChecksumType(): Promise<any>;
+    /**
+     * Retrieves the Code11 checksum type
+     */
     getCode11ChecksumType(): Promise<any>;
+    /**
+     * Retrieves the character set used for encoding barcode data
+     */
     getEncodingCharacterSet(): Promise<any>;
+    /**
+     * Retrieves the current decoding speed setting for barcode scanning
+     */
     getDecodingSpeed(): Promise<any>;
+    /**
+     * Retrieves the formatting type used for presenting decoded barcode data.
+     */
     getFormattingType(): Promise<any>;
+    /**
+     * Retrieves the threads limit
+     */
     getThreadsLimit(): Promise<any>;
+    /**
+     * Retrieves the maximum number of results to be returned from barcode scanning at once
+     */
     getMaximumResultsCount(): Promise<any>;
+    /**
+     * Retrieves the delay in milliseconds for considering duplicate barcodes during scanning
+     */
     getDuplicatesDelayMs(): Promise<any>;
+    /**
+     * Checks if a specific barcode type is enabled
+     */
     isBarcodeTypeEnabled(options: {
         type: number;
     }): Promise<any>;
+    /**
+     * Retrieves whether multi-code caching is enabled
+     */
     getMulticodeCachingEnabled(): Promise<any>;
+    /**
+     * Retrieves the caching duration (in milliseconds) for multi-code results
+     */
     getMulticodeCachingDuration(): Promise<any>;
+    /**
+     * Retrieves the value indicating whether deblurring is enabled for UPC/EAN barcodes
+     */
     isUpcEanDeblurEnabled(): Promise<any>;
+    /**
+     * Checks if the detection of misshaped 1D barcodes is enabled
+     */
     isMisshaped1DEnabled(): Promise<any>;
+    /**
+     * Retrieve whether to enable barcode thumbnail on result
+     */
     isBarcodeThumbnailOnResultEnabled(): Promise<any>;
+    /**
+     * Retrieves the threshold between duplicate scans
+     */
     getThresholdBetweenDuplicatesScans(): Promise<any>;
+    /**
+     * Checks if VIN restrictions are enabled
+     */
     isVINRestrictionsEnabled(): Promise<any>;
+    /**
+     * Retrieves the resolution for barcode scanning
+     */
     getBarkoderResolution(): Promise<any>;
@@ -182,0 +410,0 @@ }

package.json

 {
   "name": "barkoder-capacitor",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Capacitor plugin that connects to barkoderSDK which helps users scan barcodes with mobile devices",
@@ -5,0 +5,0 @@ "main": "dist/plugin.cjs.js",

README.md

@@ -280,2 +280,4 @@ # barKoder Barcode Scanner SDK plugin for Capacitor
 
+Sets the zoom factor for the device's camera, adjusting the level of zoom during barcode scanning
+
 | Param         | Type                            |
@@ -296,2 +298,4 @@ | ------------- | ------------------------------- |
 
+Enables or disables the device's flash (torch) for illumination during barcode scanning
+
 | Param         | Type                               |
@@ -323,2 +327,4 @@ | ------------- | ---------------------------------- |
 
+Initiates the barcode scanning process, allowing the application to detect and decode barcodes from the device's camera feed
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -335,2 +341,4 @@
 
+Halts the barcode scanning process, stopping the camera from capturing and processing barcode information
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -347,2 +355,4 @@
 
+Temporarily suspends the barcode scanning process, pausing the camera feed without completely stopping the scanning session
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -359,2 +369,4 @@
 
+Sets the color of the lines used to indicate the location of detected barcodes on the camera feed
+
 | Param         | Type                            |
@@ -375,2 +387,4 @@ | ------------- | ------------------------------- |
 
+Sets the width of the lines indicating the location of detected barcodes on the camera feed
+
 | Param         | Type                            |
@@ -391,2 +405,4 @@ | ------------- | ------------------------------- |
 
+Sets the color of the lines outlining the Region of Interest (ROI) for barcode scanning on the camera feed
+
 | Param         | Type                            |
@@ -407,2 +423,4 @@ | ------------- | ------------------------------- |
 
+Sets the width of the lines outlining the Region of Interest (ROI) for barcode scanning on the camera feed
+
 | Param         | Type                            |
@@ -423,2 +441,4 @@ | ------------- | ------------------------------- |
 
+Sets the background color of the overlay within the Region of Interest (ROI) for barcode scanning on the camera feed
+
 | Param         | Type                            |
@@ -439,2 +459,4 @@ | ------------- | ------------------------------- |
 
+Enables or disables the automatic closing of the scanning session upon detecting a barcode result
+
 | Param         | Type                               |
@@ -455,2 +477,4 @@ | ------------- | ---------------------------------- |
 
+Enables or disables the capturing and processing of image data when a barcode is successfully detected
+
 | Param         | Type                               |
@@ -471,2 +495,4 @@ | ------------- | ---------------------------------- |
 
+Enables or disables the inclusion of barcode location information within the image data result
+
 | Param         | Type                               |
@@ -487,2 +513,4 @@ | ------------- | ---------------------------------- |
 
+Defines the Region of Interest (ROI) on the camera preview for barcode scanning, specifying an area where the application focuses on detecting barcodes
+
 | Param         | Type                                                                       |
@@ -503,2 +531,4 @@ | ------------- | -------------------------------------------------------------------------- |
 
+Sets the threads limit
+
 | Param         | Type                            |
@@ -519,2 +549,4 @@ | ------------- | ------------------------------- |
 
+Enables or disables the display of barcode location information on the camera preview
+
 | Param         | Type                               |
@@ -535,2 +567,4 @@ | ------------- | ---------------------------------- |
 
+Enables or disables the pinch-to-zoom feature for adjusting the zoom level during barcode scanning
+
 | Param         | Type                               |
@@ -551,2 +585,4 @@ | ------------- | ---------------------------------- |
 
+Sets the visibility of the Region of Interest (ROI) on the camera preview
+
 | Param         | Type                             |
@@ -567,2 +603,4 @@ | ------------- | -------------------------------- |
 
+Sets the resolution for barcode scanning
+
 | Param         | Type                            |
@@ -583,2 +621,4 @@ | ------------- | ------------------------------- |
 
+Enables or disables the audible beep sound upon successfully decoding a barcode
+
 | Param         | Type                               |
@@ -599,2 +639,4 @@ | ------------- | ---------------------------------- |
 
+Enables or disables the device vibration upon successfully decoding a barcode.
+
 | Param         | Type                               |
@@ -630,2 +672,4 @@ | ------------- | ---------------------------------- |
 
+Sets the length range for the specified barcode type
+
 | Param         | Type                                                     |
@@ -646,2 +690,4 @@ | ------------- | -------------------------------------------------------- |
 
+Sets the encoding character set for barcode scanning
+
 | Param         | Type                            |
@@ -662,2 +708,4 @@ | ------------- | ------------------------------- |
 
+Sets the decoding speed for barcode scanning
+
 | Param         | Type                            |
@@ -678,2 +726,4 @@ | ------------- | ------------------------------- |
 
+Sets the formatting type for barcode scanning
+
 | Param         | Type                            |
@@ -694,2 +744,4 @@ | ------------- | ------------------------------- |
 
+Sets the Code11 checksum type
+
 | Param         | Type                            |
@@ -710,2 +762,4 @@ | ------------- | ------------------------------- |
 
+Sets the MSI checksum type
+
 | Param         | Type                            |
@@ -726,2 +780,4 @@ | ------------- | ------------------------------- |
 
+Sets the Code39 checksum type
+
 | Param         | Type                            |
@@ -742,2 +798,4 @@ | ------------- | ------------------------------- |
 
+Sets whether a specific barcode type is enabled
+
 | Param         | Type                                             |
@@ -758,2 +816,4 @@ | ------------- | ------------------------------------------------ |
 
+Sets whether multi-code caching is enabled
+
 | Param         | Type                               |
@@ -774,2 +834,4 @@ | ------------- | ---------------------------------- |
 
+Sets the caching duration (in milliseconds) for multi-code results
+
 | Param         | Type                            |
@@ -790,2 +852,4 @@ | ------------- | ------------------------------- |
 
+Sets the maximum number of results to be returned from barcode scanning
+
 | Param         | Type                            |
@@ -806,2 +870,4 @@ | ------------- | ------------------------------- |
 
+A boolean indicating whether to enable barcode thumbnail on result.
+
 | Param         | Type                               |
@@ -822,2 +888,4 @@ | ------------- | ---------------------------------- |
 
+Sets the delay in milliseconds for considering duplicate barcodes during scanning
+
 | Param         | Type                            |
@@ -838,2 +906,4 @@ | ------------- | ------------------------------- |
 
+Sets the threshold between duplicate scans
+
 | Param         | Type                            |
@@ -854,2 +924,4 @@ | ------------- | ------------------------------- |
 
+Sets whether the deblurring feature for UPC/EAN barcodes is enabled
+
 | Param         | Type                               |
@@ -870,2 +942,4 @@ | ------------- | ---------------------------------- |
 
+Sets whether the detection of misshaped 1D barcodes is enabled
+
 | Param         | Type                               |
@@ -886,2 +960,4 @@ | ------------- | ---------------------------------- |
 
+Sets whether Vehicle Identification Number (VIN) restrictions are enabled
+
 | Param         | Type                             |
@@ -902,2 +978,4 @@ | ------------- | -------------------------------- |
 
+Sets whether the Direct Part Marking (DPM) mode for Datamatrix barcodes is enabled.
+
 | Param         | Type                               |
@@ -918,2 +996,4 @@ | ------------- | ---------------------------------- |
 
+Configures the Barkoder functionality based on the provided configuration
+
 | Param         | Type                                             |
@@ -934,2 +1014,4 @@ | ------------- | ------------------------------------------------ |
 
+Checks whether the device has a built-in flash (torch) that can be used for illumination during barcode scanning
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -946,2 +1028,4 @@
 
+Enables or disables the automatic closing of the scanning session upon detecting a barcode result
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -958,2 +1042,4 @@
 
+Enables or disables the capturing and processing of image data when a barcode is successfully detected
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -970,2 +1056,4 @@
 
+Enables or disables the inclusion of barcode location information within the image data result
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -982,2 +1070,4 @@
 
+Checks if location in preview is enabled
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -994,2 +1084,4 @@
 
+Checks if pinch to zoom is enabled
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1006,2 +1098,4 @@
 
+Checks if the region of interest (ROI) is visible
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1018,2 +1112,4 @@
 
+Retrieves the value indicating whether a beep sound is played on successful barcode scanning
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1030,2 +1126,4 @@
 
+Retrieves the value indicating whether vibration is enabled on successful barcode scanning
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1042,2 +1140,4 @@
 
+Retrieves the version of the Barkoder library
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1054,2 +1154,4 @@
 
+Retrieves the hexadecimal color code representing the line color used to indicate the location of detected barcodes
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1066,2 +1168,4 @@
 
+Retrieves the hexadecimal color code representing the line color of the Region of Interest (ROI) on the camera preview
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1078,2 +1182,4 @@
 
+Retrieves the hexadecimal color code representing the background color of the overlay within the Region of Interest (ROI) on the camera preview
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1090,2 +1196,4 @@
 
+Retrieves the maximum available zoom factor for the device's camera
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1102,2 +1210,4 @@
 
+Retrieves the current width setting for the lines indicating the location of detected barcodes on the camera feed
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1114,2 +1224,4 @@
 
+Retrieves the current width setting for the lines outlining the Region of Interest (ROI) on the camera preview
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1126,2 +1238,4 @@
 
+Retrieves the region of interest (ROI)
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1138,2 +1252,4 @@
 
+Retrieves the length range of a specific barcode type
+
 | Param         | Type                           |
@@ -1154,2 +1270,4 @@ | ------------- | ------------------------------ |
 
+Retrieves the MSI checksum type
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1166,2 +1284,4 @@
 
+Retrieves the checksum type for Code 39 barcodes
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1178,2 +1298,4 @@
 
+Retrieves the Code11 checksum type
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1190,2 +1312,4 @@
 
+Retrieves the character set used for encoding barcode data
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1202,2 +1326,4 @@
 
+Retrieves the current decoding speed setting for barcode scanning
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1214,2 +1340,4 @@
 
+Retrieves the formatting type used for presenting decoded barcode data.
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1226,2 +1354,4 @@
 
+Retrieves the threads limit
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1238,2 +1368,4 @@
 
+Retrieves the maximum number of results to be returned from barcode scanning at once
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1250,2 +1382,4 @@
 
+Retrieves the delay in milliseconds for considering duplicate barcodes during scanning
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1262,2 +1396,4 @@
 
+Checks if a specific barcode type is enabled
+
 | Param         | Type                           |
@@ -1278,2 +1414,4 @@ | ------------- | ------------------------------ |
 
+Retrieves whether multi-code caching is enabled
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1290,2 +1428,4 @@
 
+Retrieves the caching duration (in milliseconds) for multi-code results
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1302,2 +1442,4 @@
 
+Retrieves the value indicating whether deblurring is enabled for UPC/EAN barcodes
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1314,2 +1456,4 @@
 
+Checks if the detection of misshaped 1D barcodes is enabled
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1326,2 +1470,4 @@
 
+Retrieve whether to enable barcode thumbnail on result
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1338,2 +1484,4 @@
 
+Retrieves the threshold between duplicate scans
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1350,2 +1498,4 @@
 
+Checks if VIN restrictions are enabled
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1362,2 +1512,4 @@
 
+Retrieves the resolution for barcode scanning
+
 **Returns:** <code>Promise&lt;any&gt;</code>
@@ -1364,0 +1516,0 @@

New alerts

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

13734001

increased by0.85%

Lines of code

29907

increased by0.85%

Number of lines in readme file

1444

increased by11.76%

Worsened metrics

Number of medium supply chain risk alerts

3

increased by50%

No dependency changes