Interface BlockedReason

A registered blocked reason with metadata.

interface BlockedReason {
    code: string;
    category: BlockedCategory;
    messageTemplate: string;
    recoverySteps: readonly string[];
    quickFixCommand?: string;
}

Index

Properties

code category messageTemplate recoverySteps quickFixCommand?

Properties

`Readonly`code

code: string

Unique reason code (e.g., "COMMAND_NOT_ALLOWED").

`Readonly`category

category: BlockedCategory

Category for reporting.

`Readonly`messageTemplate

messageTemplate: string

Message template with {variable} placeholders. Example: "{command} is not allowed in phase {phase}"

`Readonly`recoverySteps

recoverySteps: readonly string[]

Ordered recovery steps for the user.

`Optional` `Readonly`quickFixCommand

quickFixCommand?: string

Optional command that fixes the issue.