RecoveryRestoreResult

import type { RecoveryRestoreResult } from "@elie-laloum/outpost";

Parameters and properties

directoryRequired
string
Created destination: a clone of the repository detached at commit, without an origin remote, with the side’s changes applied.
commitRequired
string
Commit the destination is detached at.
sideRequired
"previous" | "incoming"
Side that was restored, copied from the plan.
stagingRequired
"unavailable" | "preserved"
preserved when the previous side’s staged changes were restored to the index; unavailable for incoming.
sourceRetainedRequired
true
Always true: the transfer directory stays in place after restoration.

Signature

export interface RecoveryRestoreResult {
  readonly directory: string;
  readonly commit: string;
  readonly side: "previous" | "incoming";
  readonly staging: "preserved" | "unavailable";
  readonly sourceRetained: true;
}