RecoveryVerificationOptions

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

Parameters and properties

restorabilityOptional
boolean | undefined
Clone repository into a temporary directory and check that the commits exist, the bundle unpacks and the three patches apply. Runs only when the structure checks pass; requires repository.
repositoryOptional
string | undefined
Git checkout cloned for the restorability check; a shallow or partial clone, or one with alternates, fails that check.
checksumsOptional
boolean | undefined
Hash every file listed in checksums.json with SHA-256 and compare kind, size and digest. Runs only when the earlier checks pass.
maxBytesOptional
number | undefined
Maximum bytes hashed for checksums, default 1073741824 (1 GiB). Exceeding it fails with CHECKSUM_LIMIT and leaves integrity unverified.

Signature

export interface RecoveryVerificationOptions {
  readonly restorability?: boolean;
  readonly repository?: string;
  readonly checksums?: boolean;
  readonly maxBytes?: number;
}