Skip to content
v9.1.1
Français

RecoveryRetentionOptions

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

Parameters and properties

Section titled “Parameters and properties”
  • transporterOptional
    Transport | undefined
    Plan over this transport’s objects instead of the repository’s .outpost. Only closed-logs and task-cache apply; clean-workspaces or maxWorkspaces reject with code configuration.
  • repositoryOptional
    string | undefined
    Git checkout whose .outpost is inspected, default process.cwd(), resolved to its top-level directory; a missing directory rejects with code workspace. With transporter, only recorded in the plan.
  • policyRequired
    RecoveryRetentionPolicy
    Scopes, minimum age and limits deciding which entries are eligible. Validated before inspection; an invalid or unknown field rejects with code configuration.
  • maxEntriesOptional
    number | undefined
    Maximum files and directories scanned under .outpost, or objects listed from transporter, default 100000. Exceeding it marks the plan incomplete, so no entry is eligible.

Signature

Section titled “Signature”
export interface RecoveryRetentionOptions {
  readonly transporter?: Transport;
  readonly repository?: string;
  readonly policy: RecoveryRetentionPolicy;
  readonly maxEntries?: number;
}
Section titled “Related contracts”