Skip to content
v9.1.1
Français

RecoveryQuotaOptions

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

Parameters and properties

Section titled “Parameters and properties”
  • transporterOptional
    Transport | undefined
    Measure the sizes of this transport’s objects instead of the repository’s .outpost files. An object outside the known categories makes the inventory incomplete.
  • repositoryOptional
    string | undefined
    Git checkout whose .outpost is measured, default process.cwd(), resolved to its top-level directory; a missing directory rejects with code workspace. Ignored with transporter.
  • maxBytesRequired
    number
    Limit for observed usage plus reserveBytes, in bytes; above it the call rejects with code workspace. Active reservations are not counted. Must be a non-negative safe integer.
  • reserveBytesOptional
    number | undefined
    Bytes added to observed usage for this check, default 0. Nothing is reserved.
  • maxEntriesOptional
    number | undefined
    Maximum files and directories scanned under .outpost, or objects listed from transporter, default 100000. Exceeding it makes the inventory incomplete, which rejects with code workspace.

Signature

Section titled “Signature”
export interface RecoveryQuotaOptions {
  readonly transporter?: Transport;
  readonly repository?: string;
  readonly maxBytes: number;
  readonly reserveBytes?: number;
  readonly maxEntries?: number;
}
Section titled “Related contracts”