react-native-ble-manager 12.4.2 → 12.4.4

package/dist/cjs/types.d.ts

@@ -1,6 +1,6 @@
 /**
- * android states: https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#EXTRA_STATE
- * ios states: https://developer.apple.com/documentation/corebluetooth/cbcentralmanagerstate
+ * Android states: https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#EXTRA_STATE
+ * iOS states: https://developer.apple.com/documentation/corebluetooth/cbcentralmanagerstate
  * */
 export declare enum BleState {
     /**
@@ -19,11 +19,11 @@ export declare enum BleState {
     On = "on",
     Off = "off",
     /**
-     * [android only]
+     * [Android only]
      */
     TurningOn = "turning_on",
     /**
-     * [android only]
+     * [Android only]
      */
     TurningOff = "turning_off"
 }
@@ -57,59 +57,82 @@ export interface CustomAdvertisingData {
 }
 export interface StartOptions {
     /**
-     * [iOS only]
+     * [iOS only] Show or hide the alert if the bluetooth is turned off during initialization
      */
     showAlert?: boolean;
     /**
-     * [iOS only]
+     * [iOS only] Unique key to use for CoreBluetooth state restoration
      */
     restoreIdentifierKey?: string;
     /**
-     * [iOS only]
+     * [iOS only] Unique key to use for a queue identifier on which CoreBluetooth events will be dispatched
      */
     queueIdentifierKey?: string;
     /**
-     * [android only]
+     * [Android only] Force to use the LegacyScanManager
      */
     forceLegacy?: boolean;
 }
 export interface ConnectOptions {
     /**
-     * [android only]
+     * [Android only] whether to directly connect to the remote device (false) or to automatically connect as soon as the remote device becomes available (true) ([`Android doc`](<https://developer.android.com/reference/android/bluetooth/BluetoothDevice?hl=en#connectGatt(android.content.Context,%20boolean,%20android.bluetooth.BluetoothGattCallback,%20int,%20int)>))
      */
     autoconnect?: boolean;
     /**
-     * [android only]
+     * [Android only] corresponding to the preferred phy channel ([`Android doc`](<https://developer.android.com/reference/android/bluetooth/BluetoothDevice?hl=en#connectGatt(android.content.Context,%20boolean,%20android.bluetooth.BluetoothGattCallback,%20int,%20int)>))
      */
     phy?: BleScanPhyMode;
 }
 /**
- * [android only]
+ * [Android only]
  * https://developer.android.com/reference/android/bluetooth/le/ScanSettings
  */
 export interface ScanOptions {
+    /**
+     * The UUIDs of the services to look for.
+     */
     serviceUUIDs?: string[];
+    /**
+     * The amount of seconds to scan. If not set or set to `0`, scans until `stopScan()` is called.
+     */
     seconds?: number;
     /**
-     *  iOS only: whether to allow duplicate peripheral during a scan
+     * In Android this is a ScanFilter, if present it restricts scan results to devices with a specific advertising name.
+     * This is a whole word match, not a partial search.
+     * Use with caution, it's behavior is tricky and seems to be the following:
+     * if `callbackType` is set to `AllMatches`, only the completeLocalName will be used for filtering.
+     * if `callbackType` is set to `FirstMatch`, the shortenedLocalName will be used for filtering.
+     * https://developer.android.com/reference/android/bluetooth/le/ScanFilter.Builder#setDeviceName(java.lang.String)
+     *
+     * In iOS, this is a whole word match, not a partial search.
+     */
+    exactAdvertisingName?: string | string[];
+    /**
+     * [iOS only] whether to allow duplicate peripheral during a scan
      */
     allowDuplicates?: boolean;
     /**
-     * This will only works if a ScanFilter is active. Otherwise, may not retrieve any result.
+     * [Android only] This will only work if a ScanFilter is active. Otherwise, may not retrieve any result.
      * See https://developer.android.com/reference/android/bluetooth/le/ScanSettings#MATCH_NUM_FEW_ADVERTISEMENT.
      * */
     numberOfMatches?: BleScanMatchCount;
+    /**
+     * [Android only] Defaults to `aggressive`.
+     */
     matchMode?: BleScanMatchMode;
     /**
-     * This will only works if a ScanFilter is active. Otherwise, may not retrieve any result.
+     * [Android only] This will only work if a ScanFilter is active. Otherwise, may not retrieve any result.
      * See https://developer.android.com/reference/android/bluetooth/le/ScanSettings#CALLBACK_TYPE_FIRST_MATCH.
      * Also read [this issue](https://github.com/dariuszseweryn/RxAndroidBle/issues/561#issuecomment-532295346) for a deeper understanding
-     * of the very brittle stability of ScanSettings on android.
+     * of the very brittle stability of ScanSettings on Android. Defaults to `allMatches`.
      * */
     callbackType?: BleScanCallbackType;
+    /**
+     * [Android only] Defaults to `lowPower`.
+     */
     scanMode?: BleScanMode;
     /**
-     * This is supposed to push results after a certain delay.
+     * [Android only] This is supposed to push results after a certain delay.
      * In practice it is tricky, use with caution.
      * Do not set something below 5000ms as it will wait that long anyway before pushing the first results,
      * or on some phones it will ignore that setting and behave just like it was set to 0.
@@ -118,29 +141,20 @@ export interface ScanOptions {
      */
     reportDelay?: number;
     /**
-     * Does not work in conjunction with legacy scans. Setting an unsupported PHY will result in a failure to scan,
+     * [Android only] Does not work in conjunction with legacy scans. Setting an unsupported PHY will result in a failure to scan,
      * use with caution.
      * https://developer.android.com/reference/android/bluetooth/le/ScanSettings.Builder#setPhy(int)
      */
     phy?: BleScanPhyMode;
     /**
-     * true by default for compatibility with older apps.
+     * [Android only] true by default for compatibility with older apps.
      * In that mode, scan will only retrieve advertisements data as specified by BLE 4.2 and below.
      * Change this if you want to benefit from the extended BLE 5 advertisement spec.
      * https://developer.android.com/reference/android/bluetooth/le/ScanSettings.Builder#setLegacy(boolean)
      */
     legacy?: boolean;
     /**
-     * an android ScanFilter, used if present to restrict scan results to devices with a specific advertising name.
-     * This is a whole word match, not a partial search.
-     * Use with caution, it's behavior is tricky and seems to be the following:
-     * if `callbackType` is set to `AllMatches`, only the completeLocalName will be used for filtering.
-     * if `callbackType` is set to `FirstMatch`, the shortenedLocalName will be used for filtering.
-     * https://developer.android.com/reference/android/bluetooth/le/ScanFilter.Builder#setDeviceName(java.lang.String)
-     */
-    exactAdvertisingName?: string | string[];
-    /**
-     * Android only. Filters scan results by manufacturer id and data.
+     * [Android only] Filters scan results by manufacturer id and data.
      * `manufacturerId` usually matches the company id, can be given as a hex, e.g. 0xe4f7.
      * `manufacturerData` and `manufacturerDataMask` must have the same length. For any bit in the mask, set it to 1 if
      * it needs to match the one in manufacturer data, otherwise set it to 0.
@@ -151,13 +165,6 @@ export interface ScanOptions {
         manufacturerData?: number[];
         manufacturerDataMask?: number[];
     };
-    /**
-     * When using compaion mode, only associate single peripheral.
-     *
-     * See: https://developer.android.com/reference/android/companion/AssociationRequest.Builder#setSingleDevice(boolean)
-     */
-    single?: boolean;
-    companion?: boolean;
     /**
      * [Android O+] Deliver scan results using a PendingIntent instead of the default callback.
      */
@@ -165,12 +172,12 @@ export interface ScanOptions {
 }
 export interface CompanionScanOptions {
     /**
-     * Scan only for a single peripheral.
+     * Scan only for a single peripheral. See Android's `AssociationRequest.Builder.setSingleDevice`.
      */
     single?: boolean;
 }
 /**
- * [android only]
+ * [Android only]
  */
 export declare enum BleScanMode {
     Opportunistic = -1,
@@ -179,14 +186,14 @@ export declare enum BleScanMode {
     LowLatency = 2
 }
 /**
- * [android only]
+ * [Android only]
  */
 export declare enum BleScanMatchMode {
     Aggressive = 1,
     Sticky = 2
 }
 /**
- * [android only]
+ * [Android only]
  */
 export declare enum BleScanCallbackType {
     AllMatches = 1,
@@ -194,7 +201,7 @@ export declare enum BleScanCallbackType {
     MatchLost = 4
 }
 /**
- * [android only]
+ * [Android only]
  */
 export declare enum BleScanMatchCount {
     OneAdvertisement = 1,
@@ -202,7 +209,7 @@ export declare enum BleScanMatchCount {
     MaxAdvertisements = 3
 }
 /**
- * [android only]
+ * [Android only]
  */
 export declare enum BleScanPhyMode {
     LE_1M = 1,
@@ -211,7 +218,7 @@ export declare enum BleScanPhyMode {
     ALL_SUPPORTED = 255
 }
 /**
- * [android only API 21+]
+ * [Android only API 21+]
  */
 export declare enum ConnectionPriority {
     balanced = 0,
@@ -250,33 +257,18 @@ export interface PeripheralInfo extends Peripheral {
     characteristics?: Characteristic[];
     services?: Service[];
 }
-export declare enum BleEventType {
-    BleManagerDidUpdateState = "BleManagerDidUpdateState",
-    BleManagerStopScan = "BleManagerStopScan",
-    BleManagerDiscoverPeripheral = "BleManagerDiscoverPeripheral",
-    BleManagerDidUpdateValueForCharacteristic = "BleManagerDidUpdateValueForCharacteristic",
-    BleManagerConnectPeripheral = "BleManagerConnectPeripheral",
-    BleManagerDisconnectPeripheral = "BleManagerDisconnectPeripheral",
-    /**
-     * [Android only]
-     */
-    BleManagerPeripheralDidBond = "BleManagerPeripheralDidBond",
-    /**
-     * [iOS only]
-     */
-    BleManagerCentralManagerWillRestoreState = "BleManagerCentralManagerWillRestoreState",
-    /**
-     * [iOS only]
-     */
-    BleManagerDidUpdateNotificationStateFor = "BleManagerDidUpdateNotificationStateFor"
-}
+export type EventCallback<T> = (event: T) => void | Promise<void>;
 export interface BleStopScanEvent {
     /**
-     * [iOS only]
+     * [iOS] The reason for stopping the scan. Error code 10 is used for timeouts, 0 covers everything else.
+     * [Android] The reason for stopping the scan (<https://developer.android.com/reference/android/bluetooth/le/ScanCallback#constants_1>). Error code 10 is used for timeouts
      */
     status?: number;
 }
 export interface BleManagerDidUpdateStateEvent {
+    /**
+     * The new BLE state
+     */
     state: BleState;
 }
 export interface BleConnectPeripheralEvent {
@@ -285,7 +277,9 @@ export interface BleConnectPeripheralEvent {
      */
     readonly peripheral: string;
     /**
-     * [android only]
+     * [Android only]
+     *
+     * Connect reason.
      */
     readonly status?: number;
 }
@@ -300,7 +294,7 @@ export interface BleDisconnectPeripheralEvent {
      */
     readonly peripheral: string;
     /**
-     * [android only] disconnect reason.
+     * [Android only] disconnect reason.
      */
     readonly status?: number;
     /**

package/dist/cjs/types.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BleEventType = exports.ConnectionPriority = exports.BleScanPhyMode = exports.BleScanMatchCount = exports.BleScanCallbackType = exports.BleScanMatchMode = exports.BleScanMode = exports.BleState = void 0;
+exports.ConnectionPriority = exports.BleScanPhyMode = exports.BleScanMatchCount = exports.BleScanCallbackType = exports.BleScanMatchMode = exports.BleScanMode = exports.BleState = void 0;
 /**
- * android states: https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#EXTRA_STATE
- * ios states: https://developer.apple.com/documentation/corebluetooth/cbcentralmanagerstate
+ * Android states: https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#EXTRA_STATE
+ * iOS states: https://developer.apple.com/documentation/corebluetooth/cbcentralmanagerstate
  * */
 var BleState;
 (function (BleState) {
@@ -23,16 +23,16 @@ var BleState;
     BleState["On"] = "on";
     BleState["Off"] = "off";
     /**
-     * [android only]
+     * [Android only]
      */
     BleState["TurningOn"] = "turning_on";
     /**
-     * [android only]
+     * [Android only]
      */
     BleState["TurningOff"] = "turning_off";
 })(BleState || (exports.BleState = BleState = {}));
 /**
- * [android only]
+ * [Android only]
  */
 var BleScanMode;
 (function (BleScanMode) {
@@ -42,7 +42,7 @@ var BleScanMode;
     BleScanMode[BleScanMode["LowLatency"] = 2] = "LowLatency";
 })(BleScanMode || (exports.BleScanMode = BleScanMode = {}));
 /**
- * [android only]
+ * [Android only]
  */
 var BleScanMatchMode;
 (function (BleScanMatchMode) {
@@ -50,7 +50,7 @@ var BleScanMatchMode;
     BleScanMatchMode[BleScanMatchMode["Sticky"] = 2] = "Sticky";
 })(BleScanMatchMode || (exports.BleScanMatchMode = BleScanMatchMode = {}));
 /**
- * [android only]
+ * [Android only]
  */
 var BleScanCallbackType;
 (function (BleScanCallbackType) {
@@ -59,7 +59,7 @@ var BleScanCallbackType;
     BleScanCallbackType[BleScanCallbackType["MatchLost"] = 4] = "MatchLost";
 })(BleScanCallbackType || (exports.BleScanCallbackType = BleScanCallbackType = {}));
 /**
- * [android only]
+ * [Android only]
  */
 var BleScanMatchCount;
 (function (BleScanMatchCount) {
@@ -68,7 +68,7 @@ var BleScanMatchCount;
     BleScanMatchCount[BleScanMatchCount["MaxAdvertisements"] = 3] = "MaxAdvertisements";
 })(BleScanMatchCount || (exports.BleScanMatchCount = BleScanMatchCount = {}));
 /**
- * [android only]
+ * [Android only]
  */
 var BleScanPhyMode;
 (function (BleScanPhyMode) {
@@ -78,7 +78,7 @@ var BleScanPhyMode;
     BleScanPhyMode[BleScanPhyMode["ALL_SUPPORTED"] = 255] = "ALL_SUPPORTED";
 })(BleScanPhyMode || (exports.BleScanPhyMode = BleScanPhyMode = {}));
 /**
- * [android only API 21+]
+ * [Android only API 21+]
  */
 var ConnectionPriority;
 (function (ConnectionPriority) {
@@ -86,25 +86,4 @@ var ConnectionPriority;
     ConnectionPriority[ConnectionPriority["high"] = 1] = "high";
     ConnectionPriority[ConnectionPriority["low"] = 2] = "low";
 })(ConnectionPriority || (exports.ConnectionPriority = ConnectionPriority = {}));
-var BleEventType;
-(function (BleEventType) {
-    BleEventType["BleManagerDidUpdateState"] = "BleManagerDidUpdateState";
-    BleEventType["BleManagerStopScan"] = "BleManagerStopScan";
-    BleEventType["BleManagerDiscoverPeripheral"] = "BleManagerDiscoverPeripheral";
-    BleEventType["BleManagerDidUpdateValueForCharacteristic"] = "BleManagerDidUpdateValueForCharacteristic";
-    BleEventType["BleManagerConnectPeripheral"] = "BleManagerConnectPeripheral";
-    BleEventType["BleManagerDisconnectPeripheral"] = "BleManagerDisconnectPeripheral";
-    /**
-     * [Android only]
-     */
-    BleEventType["BleManagerPeripheralDidBond"] = "BleManagerPeripheralDidBond";
-    /**
-     * [iOS only]
-     */
-    BleEventType["BleManagerCentralManagerWillRestoreState"] = "BleManagerCentralManagerWillRestoreState";
-    /**
-     * [iOS only]
-     */
-    BleEventType["BleManagerDidUpdateNotificationStateFor"] = "BleManagerDidUpdateNotificationStateFor";
-})(BleEventType || (exports.BleEventType = BleEventType = {}));
 //# sourceMappingURL=types.js.map

package/dist/cjs/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";;;AAAA;;;KAGK;AACL,IAAY,QAwBX;AAxBD,WAAY,QAAQ;IAClB;;OAEG;IACH,+BAAmB,CAAA;IACnB;;OAEG;IACH,mCAAuB,CAAA;IACvB,uCAA2B,CAAA;IAC3B;;OAEG;IACH,yCAA6B,CAAA;IAC7B,qBAAS,CAAA;IACT,uBAAW,CAAA;IACX;;OAEG;IACH,oCAAwB,CAAA;IACxB;;OAEG;IACH,sCAA0B,CAAA;AAC5B,CAAC,EAxBW,QAAQ,wBAAR,QAAQ,QAwBnB;AAuJD;;GAEG;AACH,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,gEAAkB,CAAA;IAClB,qDAAY,CAAA;IACZ,qDAAY,CAAA;IACZ,yDAAc,CAAA;AAChB,CAAC,EALW,WAAW,2BAAX,WAAW,QAKtB;AAED;;GAEG;AACH,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,mEAAc,CAAA;IACd,2DAAU,CAAA;AACZ,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B;AAED;;GAEG;AACH,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,yEAAc,CAAA;IACd,yEAAc,CAAA;IACd,uEAAa,CAAA;AACf,CAAC,EAJW,mBAAmB,mCAAnB,mBAAmB,QAI9B;AAED;;GAEG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,iFAAoB,CAAA;IACpB,mFAAqB,CAAA;IACrB,mFAAqB,CAAA;AACvB,CAAC,EAJW,iBAAiB,iCAAjB,iBAAiB,QAI5B;AAED;;GAEG;AACH,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,qDAAS,CAAA;IACT,qDAAS,CAAA;IACT,2DAAY,CAAA;IACZ,uEAAmB,CAAA;AACrB,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB;AAED;;GAEG;AACH,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,mEAAY,CAAA;IACZ,2DAAQ,CAAA;IACR,yDAAO,CAAA;AACT,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B;AAsCD,IAAY,YAmBX;AAnBD,WAAY,YAAY;IACtB,qEAAqD,CAAA;IACrD,yDAAyC,CAAA;IACzC,6EAA6D,CAAA;IAC7D,uGAAuF,CAAA;IACvF,2EAA2D,CAAA;IAC3D,iFAAiE,CAAA;IACjE;;OAEG;IACH,2EAA2D,CAAA;IAC3D;;OAEG;IACH,qGAAqF,CAAA;IACrF;;OAEG;IACH,mGAAmF,CAAA;AACrF,CAAC,EAnBW,YAAY,4BAAZ,YAAY,QAmBvB"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";;;AAAA;;;KAGK;AACL,IAAY,QAwBX;AAxBD,WAAY,QAAQ;IAClB;;OAEG;IACH,+BAAmB,CAAA;IACnB;;OAEG;IACH,mCAAuB,CAAA;IACvB,uCAA2B,CAAA;IAC3B;;OAEG;IACH,yCAA6B,CAAA;IAC7B,qBAAS,CAAA;IACT,uBAAW,CAAA;IACX;;OAEG;IACH,oCAAwB,CAAA;IACxB;;OAEG;IACH,sCAA0B,CAAA;AAC5B,CAAC,EAxBW,QAAQ,wBAAR,QAAQ,QAwBnB;AA8JD;;GAEG;AACH,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,gEAAkB,CAAA;IAClB,qDAAY,CAAA;IACZ,qDAAY,CAAA;IACZ,yDAAc,CAAA;AAChB,CAAC,EALW,WAAW,2BAAX,WAAW,QAKtB;AAED;;GAEG;AACH,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,mEAAc,CAAA;IACd,2DAAU,CAAA;AACZ,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B;AAED;;GAEG;AACH,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,yEAAc,CAAA;IACd,yEAAc,CAAA;IACd,uEAAa,CAAA;AACf,CAAC,EAJW,mBAAmB,mCAAnB,mBAAmB,QAI9B;AAED;;GAEG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,iFAAoB,CAAA;IACpB,mFAAqB,CAAA;IACrB,mFAAqB,CAAA;AACvB,CAAC,EAJW,iBAAiB,iCAAjB,iBAAiB,QAI5B;AAED;;GAEG;AACH,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,qDAAS,CAAA;IACT,qDAAS,CAAA;IACT,2DAAY,CAAA;IACZ,uEAAmB,CAAA;AACrB,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB;AAED;;GAEG;AACH,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,mEAAY,CAAA;IACZ,2DAAQ,CAAA;IACR,yDAAO,CAAA;AACT,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B"}