Skip to content
v9.1.1
Français

StorageInventory

Parameters and properties

Section titled “Parameters and properties”
  • 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 StorageInventory {
  readonly root: string;
  readonly categories: readonly StorageCategory[];
  readonly usage: Readonly<StorageUsage>;
  readonly issues: readonly StorageIssue[];
  readonly complete: boolean;
  readonly scannedEntries: number;
  readonly maxEntries: number;
}
Section titled “Related contracts”