ScanError
Defined in: console-sdk/src/errors/classes.ts:64
Platform-level Bluetooth failure (ble/*): the adapter is unsupported,
unauthorized, or powered off, or scanning itself failed.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ScanError(
code,message,options?):ScanError
Defined in: console-sdk/src/errors/classes.ts:69
Creates a ble/* platform error.
Parameters
Section titled “Parameters”"ble/unsupported" | "ble/unauthorized" | "ble/powered-off" | "ble/scan-failed"
message
Section titled “message”string
options?
Section titled “options?”Returns
Section titled “Returns”ScanError
Overrides
Section titled “Overrides”ConsoleSdkError.constructor
Properties
Section titled “Properties”cause?
Section titled “cause?”
readonlyoptionalcause?:unknown
Defined in: console-sdk/src/errors/classes.ts:41
The underlying lower-level error, when one exists. Typed unknown —
never a ble-plx (or any other dependency) type publicly.
Inherited from
Section titled “Inherited from”
readonlycode:"ble/unsupported"|"ble/unauthorized"|"ble/powered-off"|"ble/scan-failed"
Defined in: console-sdk/src/errors/classes.ts:66
The ble/* code identifying the platform failure.
Overrides
Section titled “Overrides”deviceId?
Section titled “deviceId?”
readonlyoptionaldeviceId?:DeviceId
Defined in: console-sdk/src/errors/classes.ts:35
Present whenever the failure is attributable to a specific device.
Inherited from
Section titled “Inherited from”message
Section titled “message”message:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
Section titled “Inherited from”name:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
Section titled “Inherited from”stack?
Section titled “stack?”
optionalstack?:string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078