IDashboardCommandFailedPayload
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Payload of the IDashboardCommandFailed event.
export interface IDashboardCommandFailedPayload<TCommand extends IDashboardCommand>
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| TCommand | (BETA) The command that failed. | |
| Error | (BETA) (Optional) Error that has occurred and caused the command to fail. | |
| string | (BETA) Message explaining the nature of the failure. | |
| (BETA) Reason for the failure. |
Property details
IDashboardCommandFailedPayload.commandpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The command that failed.
readonly command: TCommand;
IDashboardCommandFailedPayload.errorpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Error that has occurred and caused the command to fail.
readonly error?: Error;
IDashboardCommandFailedPayload.messagepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Message explaining the nature of the failure.
readonly message: string;
IDashboardCommandFailedPayload.reasonpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Reason for the failure.
readonly reason: ActionFailedErrorReason;