Aller au contenu
English

archiveRecovery

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

Envoie un snapshot vérifié d’un transfert de récupération local par blocs de 4 Mio, publie son manifeste en dernier et renvoie la référence du manifeste. Le dossier source est conservé. Un envoi interrompu peut laisser des blocs non référencés mais ne publie jamais de manifeste.

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

  • optionsRequis
    RecoveryArchiveOptions
    Transfert de récupération local vérifié, transport de destination et limite totale des contenus.
  • options.directoryRequis
    string
    Transfert existant contenant state.json, checksums.json et les patches, bundles et fichiers supplémentaires requis.
  • options.maxBytesOptionnel
    number | undefined
    Limite totale des contenus, 1 Gio par défaut ; s’applique au snapshot local et à l’envoi.
  • 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 qui reçoit les événements de début et de fin de l’envoi de l’archive.

Promise<TransportReference>

export declare function archiveRecovery(
  options: RecoveryArchiveOptions,
  observation?: ObservationHub,
): Promise<TransportReference>;