From 87b0715fc0757736811cfc2c2db7601fa7f4b4de Mon Sep 17 00:00:00 2001 From: pwespi Date: Sat, 20 Nov 2021 16:00:04 +0100 Subject: [PATCH] docs: update some doc strings --- README.md | 6 +++--- src/bleClient.ts | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 79023ece..e752c2e8 100644 --- a/README.md +++ b/README.md @@ -559,7 +559,7 @@ createBond(deviceId: string) => Promise ``` Create a bond with a peripheral BLE device. -Only available on Android. +Only available on **Android**. On iOS bonding is handled by the OS. | Param | Type | Description | | -------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- | @@ -574,7 +574,7 @@ isBonded(deviceId: string) => Promise ``` Report whether a peripheral BLE device is bonded. -Only available on Android. +Only available on **Android**. On iOS bonding is handled by the OS. | Param | Type | Description | | -------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- | @@ -604,7 +604,7 @@ Disconnect from a peripheral BLE device. For an example, see [usage](#usage). getServices(deviceId: string) => Promise ``` -Get services and characteristics of device. +Get services, characteristics and descriptors of a device. | Param | Type | Description | | -------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- | diff --git a/src/bleClient.ts b/src/bleClient.ts index ef78f666..9dae8fac 100644 --- a/src/bleClient.ts +++ b/src/bleClient.ts @@ -137,14 +137,14 @@ export interface BleClientInterface { /** * Create a bond with a peripheral BLE device. - * Only available on Android. + * Only available on **Android**. On iOS bonding is handled by the OS. * @param deviceId The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) */ createBond(deviceId: string): Promise; /** * Report whether a peripheral BLE device is bonded. - * Only available on Android. + * Only available on **Android**. On iOS bonding is handled by the OS. * @param deviceId The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) */ isBonded(deviceId: string): Promise; @@ -156,7 +156,7 @@ export interface BleClientInterface { disconnect(deviceId: string): Promise; /** - * Get services and characteristics of device. + * Get services, characteristics and descriptors of a device. * @param deviceId The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) */ getServices(deviceId: string): Promise;