docs: include manufacturerData in scan filters

Author: peitschie

README.md

@@ -935,6 +935,15 @@ Stop listening to the changes of the value of a characteristic. For an example,
 | **`optionalServices`** | <code>string[]</code>                         | For **web**, all services that will be used have to be listed under services or optionalServices, e.g. [numberToUUID(0x180f)] (see [UUID format](#uuid-format))                                                                                           |
 | **`allowDuplicates`**  | <code>boolean</code>                          | Normally scans will discard the second and subsequent advertisements from a single device. If you need to receive them, set allowDuplicates to true (only applicable in `requestLEScan`). (default: false)                                                |
 | **`scanMode`**         | <code><a href="#scanmode">ScanMode</a></code> | Android scan mode (default: <a href="#scanmode">ScanMode.SCAN_MODE_BALANCED</a>)                                                                                                                                                                          |
+| **`manufacturerData`** | <code>ManufacturerDataFilter[]</code>         | Allow scanning for devices with a specific manufacturer data https://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/requestDevice#manufacturerdata                                                                                                    |
+
+#### ManufacturerDataFilter
+
+| Prop                    | Type                                              | Description                                                                                                                                                                                                 |
+| ----------------------- | ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`companyIdentifier`** | <code>number</code>                               | Company ID (sometimes called the manufacturer ID) to search for in the manufacturer data field.                                                                                                             |
+| **`dataPrefix`**        | <code><a href="#uint8array">Uint8Array</a></code> | Prefix to match in the manufacturer data field. On **Android** this field is mandatory.                                                                                                                     |
+| **`mask`**              | <code><a href="#uint8array">Uint8Array</a></code> | Set filter on partial manufacture data. For any bit in the mask, set it the 1 if it needs to match the one in manufacturer data, otherwise set it to 0. The `mask` must have the same length of dataPrefix. |
 
 #### ScanResult
 

src/definitions.ts

@@ -50,7 +50,7 @@ export interface RequestBleDeviceOptions {
    * Allow scanning for devices with a specific manufacturer data
    * https://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/requestDevice#manufacturerdata
    */
-  manufacturerData?: { companyIdentifier: number; dataPrefix?: Uint8Array; mask?: Uint8Array }[];
+  manufacturerData?: ManufacturerDataFilter[];
 }
 
 /**
@@ -95,6 +95,25 @@ export enum ConnectionPriority {
   CONNECTION_PRIORITY_LOW_POWER = 2,
 }
 
+export interface ManufacturerDataFilter {
+  /**
+   * Company ID (sometimes called the manufacturer ID) to search for in the manufacturer data field.
+   */
+  companyIdentifier: number;
+
+  /**
+   * Prefix to match in the manufacturer data field.
+   * On **Android** this field is mandatory.
+   */
+  dataPrefix?: Uint8Array;
+
+  /**
+   * Set filter on partial manufacture data. For any bit in the mask, set it the 1 if it needs to match the one in manufacturer data, otherwise set it to 0.
+   * The `mask` must have the same length of dataPrefix.
+   */
+  mask?: Uint8Array;
+}
+
 export interface BleDevice {
   /**
    * ID of the device, which will be needed for further calls.
@@ -297,12 +316,12 @@ export interface BluetoothLePlugin {
   getBondedDevices(): Promise<GetDevicesResult>;
   addListener(
     eventName: 'onEnabledChanged',
-    listenerFunc: (result: BooleanResult) => void,
+    listenerFunc: (result: BooleanResult) => void
   ): Promise<PluginListenerHandle>;
   addListener(eventName: string, listenerFunc: (event: ReadResult) => void): Promise<PluginListenerHandle>;
   addListener(
     eventName: 'onScanResult',
-    listenerFunc: (result: ScanResultInternal) => void,
+    listenerFunc: (result: ScanResultInternal) => void
   ): Promise<PluginListenerHandle>;
   connect(options: DeviceIdOptions & TimeoutOptions): Promise<void>;
   createBond(options: DeviceIdOptions & TimeoutOptions): Promise<void>;