Skip to content
v9.1.1
Français

RecoveryVerification

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

Parameters and properties

Section titled “Parameters and properties”
  • directoryRequired
    string
    Resolved real path of the verified transfer directory.
  • scopeRequired
    "transfer-structure" | "transfer-restorability"
    transfer-restorability when restorability was requested, otherwise transfer-structure.
  • completeRequired
    boolean
    Whether every check passed.
  • integrityRequired
    RecoveryIntegrity
    checksums-match or checksums-mismatch after checksum verification; unverified when checksums were not requested or could not run to the end.
  • checksumsOptional
    RecoveryChecksumResult | undefined
    Checksum integrity, bytesChecked, maxBytes and per-file checks; present when checksums was requested and the earlier checks passed.
  • checksRequired
    readonly RecoveryStructureCheck[]
    Every check run, in order, with path, pass or fail status and a code such as FILE_PRESENT, CHECKSUM_MISMATCH or PATCH_APPLIES.

Signature

Section titled “Signature”
export interface RecoveryVerification {
  readonly directory: string;
  readonly scope: "transfer-structure" | "transfer-restorability";
  readonly complete: boolean;
  readonly integrity: RecoveryIntegrity;
  readonly checksums?: RecoveryChecksumResult;
  readonly checks: readonly RecoveryStructureCheck[];
}
Section titled “Related contracts”