@ledgerhq/live-common
Version:
Common ground for the Ledger Live apps
27 lines • 1.04 kB
TypeScript
import { GetBatteryStatusesActionState } from "../actions/getBatteryStatuses";
import { BatteryStatusTypes } from "../../hw/getBatteryStatus";
export type UseBatteryStatusesArgs = {
deviceId?: string;
statuses: BatteryStatusTypes[];
};
/**
* Hook used to query one or multiple battery statuses for Ledger Stax. The state will contain an array of with all the
* requested statuses in corresponding order.
*
* @param deviceId
* @param statuses A list of status types to query
*
* @returns An object containing:
* - the current state of the request
* - a boolean that informs if the request is complete
* - a function to trigger an retrigger the device action
*/
export declare const useBatteryStatuses: ({ deviceId, statuses, }: UseBatteryStatusesArgs) => {
batteryStatusesState: GetBatteryStatusesActionState;
requestCompleted: boolean;
triggerRequest: () => void;
cancelRequest: () => void;
isBatteryLow: boolean;
lowBatteryPercentage: number;
};
//# sourceMappingURL=useBatteryStatuses.d.ts.map