pruneRecoveryRetention

Rôle et comportement

Supprime les entrées éligibles d’un plan complet, en revérifiant chacune contre un nouveau plan ; un candidat modifié ou en échec est conservé avec son motif. Les worktrees sont supprimés sous le verrou de leur branche, qui est conservée ; les objets de journal et de cache sont effacés par écritures conditionnelles. Un plan incomplet ou un transporter qui ne correspond pas au source du plan rejette avec le code configuration.

Exemple complet et règles détaillées.

Paramètres et propriétés

• planRequis
  RecoveryRetentionPlan
  Plan complet issu de planRecoveryRetention() ; seules ses entrées éligibles sont candidates.
• optionsOptionnel
  TransportStoreOptions | undefined
  { transporter } ayant servi à construire un plan dont source vaut transport ; à omettre pour un plan local.
• options.transporterRequis
  Transport
  Transport objet appartenant à l’appelant, utilisé par le store ou l’opération. Fermer un workflow ou une sandbox ne ferme pas ce transport.
• observationOptionnel
  ObservationHub | undefined
  Hub recevant l’événement d’opération retention.prune au démarrage, puis à la fin ou en échec avec sa durée.

Retour

Promise<RecoveryPruneResult>

Signature

export declare function pruneRecoveryRetention(
  plan: RecoveryRetentionPlan,
  options?: TransportStoreOptions,
  observation?: ObservationHub,
): Promise<RecoveryPruneResult>;

Contrats associés

• ObservationHub
• RecoveryPruneResult
• RecoveryRetentionPlan
• TransportStoreOptions