Skip to content
v9.1.1
Français

archiveRecovery

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

Purpose and behavior

Section titled “Purpose and behavior”

Upload a verified snapshot of a local recovery transfer in 4 MiB chunks, publish its manifest last and return the manifest reference. The source directory is kept. An interrupted upload can leave unreferenced chunks but never publishes a manifest.

Complete example and detailed rules.

Parameters and properties

Section titled “Parameters and properties”
  • optionsRequired
    RecoveryArchiveOptions
    Verified local recovery transfer, destination transport and total payload bound.
  • options.directoryRequired
    string
    Existing recovery transfer containing state.json, checksums.json and all required patches, bundles and extra files.
  • options.maxBytesOptional
    number | undefined
    Total payload bound, default 1 GiB; applies to the local snapshot and to the upload.
  • options.transporterRequired
    Transport
    Caller-owned object transport used by the store or operation. Closing a workflow or sandbox does not close this transport.
  • observationOptional
    ObservationHub | undefined
    Hub that receives the start and end events of the archive upload.

Returns

Section titled “Returns”

Promise<TransportReference>

Signature

Section titled “Signature”
export declare function archiveRecovery(
  options: RecoveryArchiveOptions,
  observation?: ObservationHub,
): Promise<TransportReference>;
Section titled “Related contracts”