Skip to content
v9.1.1
Français

RecoveryInspection

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

Parameters and properties

Section titled “Parameters and properties”
  • repositoryRequired
    string
    Top-level root of the inspected Git checkout in local mode. In transport mode, the repository option echoed back, or an empty string.
  • activityRequired
    "unverified"
    Always unverified: neither files nor transport objects prove that retained resources are inactive.
  • gitOptional
    WorkspaceGitInspection | undefined
    Git worktree state report, present when Git inspection was requested.
  • locksOptional
    LockInspection | undefined
    Local lock ownership report, present when lock inspection was requested.
  • resourcesOptional
    ResourceInspection | undefined
    Recorded sandbox activity, present when resources was true. Ownership is judged against the current process in local mode and always unknown in transport mode.
  • rootRequired
    string
    Inspected directory, the repository’s .outpost, or transport for a transport inventory.
  • categoriesRequired
    readonly StorageCategory[]
    One group per category, listed even when empty: recovery, logs, locks, workspaces and storage locally; artifacts, checkpoints, conversations, recovery, logs, reservations, resources and task-cache for a transport.
  • usageRequired
    Readonly<StorageUsage>
    Observed storage bytes and counts of files, directories, symbolic links and other entries.
  • issuesRequired
    readonly StorageIssue[]
    Entries that could not be fully inspected, each with a code such as ENTRY_LIMIT, DEPTH_LIMIT, UNSUPPORTED_TYPE or a filesystem error code.
  • completeRequired
    boolean
    true when the scan recorded no issue.
  • scannedEntriesRequired
    number
    Entries visited, at most maxEntries: filesystem entries locally, listed objects for a transport.
  • maxEntriesRequired
    number
    Scan bound, default 100000. Reaching it records an ENTRY_LIMIT issue and makes the inventory incomplete.

Signature

Section titled “Signature”
export interface RecoveryInspection extends StorageInventory {
  readonly repository: string;
  readonly activity: "unverified";
  readonly git?: WorkspaceGitInspection;
  readonly locks?: LockInspection;
  readonly resources?: ResourceInspection;
}
Section titled “Related contracts”