Aller au contenu
English

materializeRecoveryArchive

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

Télécharge une archive de récupération dans destination, en vérifiant la révision et le SHA-256 de chaque bloc puis les sommes de contrôle du transfert, et renvoie destination. Liens symboliques et modes de fichiers sont restaurés ; en cas d’échec, la destination partielle est conservée. Ramenez ensuite le travail avec planRecoveryRestore() et restoreRecoveryTransfer().

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

  • optionsRequis
    RecoveryArchiveRestoreOptions
    Référence exacte d’archive, transport, nouvelle destination locale et limite de vérification.
  • options.referenceRequis
    TransportReference
    Manifeste versionné renvoyé par archiveRecovery ; chaque révision de bloc et SHA-256 est vérifié.
  • options.destinationRequis
    string
    Nouveau dossier local dont le parent existe. Les destinations existantes sont refusées ; les données partielles sont conservées en cas d’échec.
  • options.maxBytesOptionnel
    number | undefined
    Limite positive totale des contenus restaurés, 1 Gio par défaut ; borne aussi la vérification d’intégrité de récupération.
  • 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 du téléchargement de l’archive.

Promise<string>

export declare function materializeRecoveryArchive(
  options: RecoveryArchiveRestoreOptions,
  observation?: ObservationHub,
): Promise<string>;