Skip to content

Commit

Permalink
docs: add deprecation note about enable and disable
Browse files Browse the repository at this point in the history
  • Loading branch information
pwespi committed Jul 22, 2023
1 parent d83d655 commit 948c887
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/bleClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,14 @@ export interface BleClientInterface {
/**
* Enable Bluetooth.
* Only available on **Android**.
* @deprecated See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#enable()
*/
enable(): Promise<void>;

/**
* Disable Bluetooth.
* Only available on **Android**.
* @deprecated See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#disable()
*/
disable(): Promise<void>;

Expand Down Expand Up @@ -100,7 +102,7 @@ export interface BleClientInterface {
/**
* Start scanning for BLE devices to interact with according to the filters in the options. The callback will be invoked on each device that is found.
* Scanning will continue until `stopLEScan` is called. For an example, see [usage](#usage).
* **NOTE**: Use with care on **web** platform, the required API is still behind a flag in most browsers.
* **Note**: Use with care on **web** platform, the required API is still behind a flag in most browsers.
* @param options
* @param callback
*/
Expand Down

0 comments on commit 948c887

Please sign in to comment.