RecoveryRestoreOptions

Parameters and properties

• directoryRequired
  string
  Retained transfer directory, as named by details.recovery of the synchronization error. It must contain state.json and checksums.json.
• repositoryRequired
  string
  Host Git repository cloned into the destination; it is only read. Partial, shallow or alternates-based repositories fail the Git check.
• destinationRequired
  string
  New directory to create. Its parent must exist; the path must not exist and must lie outside the repository, its Git metadata and the transfer.
• sideRequired
  "previous" | "incoming"
  previous restores the host worktree as backed up before the transfer, staged index included; incoming restores the sandbox’s commits, uncommitted changes and untracked files.
• maxBytesOptional
  number | undefined
  Maximum transfer bytes copied and hashed, default 1073741824 (1 GiB). Exceeding it rejects with code configuration.

Signature

export interface RecoveryRestoreOptions {
  readonly directory: string;
  readonly repository: string;
  readonly destination: string;
  readonly side: "previous" | "incoming";
  readonly maxBytes?: number;
}