@ledgerhq/live-common
Version:
Common ground for the Ledger Live apps
21 lines • 775 B
TypeScript
import { BleError } from "../types";
export type useBleDevicePairingArgs = {
deviceId: string;
};
export type PairingError = BleError | null;
export type useBleDevicePairingResult = {
isPaired: boolean;
pairingError: PairingError;
};
/**
* Triggers a BLE pairing with a device
* @param deviceId A BLE device id
* @returns An object containing:
* - isPaired: a boolean set to true if the device has been paired, false otherwise
* - pairingError: any PairingError that occurred, null otherwise
*
* When the device is locked, notify the pairing error and retry
* until the device is unlocked
*/
export declare const useBleDevicePairing: ({ deviceId, }: useBleDevicePairingArgs) => useBleDevicePairingResult;
//# sourceMappingURL=useBleDevicePairing.d.ts.map