CommandError

Defined in: console-sdk/src/errors/classes.ts:143

A per-console command failed (command/*): the device is not connected, the command is unsupported by its firmware, it timed out, was rejected, or the console was busy.

Extends

ConsoleSdkError

Constructors

Constructor

new CommandError(code, command, message, options?): CommandError

Defined in: console-sdk/src/errors/classes.ts:151

Creates a command/* error for the named semantic command.

Parameters

code

"command/not-connected" | "command/unsupported" | "command/timeout" | "command/rejected" | "command/busy"

command

string

message

string

options?

ConsoleSdkErrorOptions

Returns

CommandError

Overrides

ConsoleSdkError.constructor

Properties

cause?

readonly optional cause?: 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

ConsoleSdkError.cause

code

readonly code: "command/not-connected" | "command/unsupported" | "command/timeout" | "command/rejected" | "command/busy"

Defined in: console-sdk/src/errors/classes.ts:145

The command/* code identifying the command failure.

Overrides

ConsoleSdkError.code

command

readonly command: string

Defined in: console-sdk/src/errors/classes.ts:148

Semantic command name ('pause', 'setDisplayUnits', …) — never an opcode.

deviceId?

readonly optional deviceId?: DeviceId

Defined in: console-sdk/src/errors/classes.ts:35

Present whenever the failure is attributable to a specific device.

Inherited from

ConsoleSdkError.deviceId

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

ConsoleSdkError.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

ConsoleSdkError.name

stack?

optional stack?: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

ConsoleSdkError.stack