Interface ApplyWorkspaceEditResult

The result returned from the apply workspace edit request.

3.17 renamed from ApplyWorkspaceEditResponse

interface ApplyWorkspaceEditResult {
    applied: boolean;
    failedChange?: number;
    failureReason?: string;
}

Properties

applied: boolean

Indicates whether the edit was applied or not.

failedChange?: number

Depending on the client's failure handling strategy failedChange might contain the index of the change that failed. This property is only available if the client signals a failureHandlingStrategy in its client capabilities.

failureReason?: string

An optional textual description for why the edit was not applied. This may be used by the server for diagnostic logging or to provide a suitable error for a request that triggered the edit.