IDashboardCommandFailed
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
This event is emitted if a particular command processing fails. The failure may be for two general reasons:
A user error was made; dispatched command is found to have bad payload or the dispatched command is not applicable in the current state of the dashboard
An internal error has occurred in the dashboard component - highly likely due to a bug.
export interface IDashboardCommandFailed<TCommand extends IDashboardCommand = IDashboardCommand> extends IDashboardEvent
Extends: IDashboardEvent
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| IDashboardCommandFailedPayload<TCommand> | (BETA) | |
| “GDC.DASH/EVT.COMMAND.FAILED” | (BETA) |
Property details
IDashboardCommandFailed.payloadpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
readonly payload: IDashboardCommandFailedPayload<TCommand>;
IDashboardCommandFailed.typepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
readonly type: "GDC.DASH/EVT.COMMAND.FAILED";