Interface CommandResult

Result returned by command submission APIs.

interface CommandResult {
    error?: string;
    index?: number;
    leaderId?: string;
    success: boolean;
}

Properties

error?: string

Human-readable reason for failure when success is false.

index?: number

Index where the command was appended or committed when available.

leaderId?: string

Current known leader when the receiver is not leader.

success: boolean

Indicates whether the operation completed successfully.