prorm API Reference
    Preparing search index...

    Interface BackupSource

    interface BackupSource {
        type: "s3" | "filesystem" | "azure" | "gcp" | "nfs";
        bucket?: string;
        path: string;
        credentials?: {
            accessKeyId?: string;
            secretAccessKey?: string;
            region?: string;
        };
        encryption?: {
            enabled: boolean;
            algorithm?: "AES-256"
            | "AES-256-GCM";
            keyId?: string;
        };
        computeChecksum?: (backupId: string) => Promise<string>;
        checkReadable?: (backupId: string) => Promise<boolean>;
    }
    Index
    type bucket? path credentials? encryption? computeChecksum? checkReadable?
    type: "s3" | "filesystem" | "azure" | "gcp" | "nfs"

    Storage type

    bucket?: string

    Storage location - bucket name or path

    path: string

    Path prefix or directory path

    credentials?: {
        accessKeyId?: string;
        secretAccessKey?: string;
        region?: string;
    }

    Optional credentials

    encryption?: {
        enabled: boolean;
        algorithm?: "AES-256" | "AES-256-GCM";
        keyId?: string;
    }

    Encryption settings

    computeChecksum?: (backupId: string) => Promise<string>

    Optional callback that computes the real checksum (e.g. sha256 hex digest) of the backup content for backupId. Required for non- filesystem source types (s3/azure/gcp/nfs) if you want real checksum verification, since this library does not bundle any cloud SDKs. Without it, checksum verification for those types is inconclusive (reported as a 'warning', never fabricated as a pass).

    checkReadable?: (backupId: string) => Promise<boolean>

    Optional callback that returns true if the backup content for backupId actually exists and is readable/non-corrupted at the source. Required for non-filesystem source types to get a real integrity check; otherwise integrity verification is inconclusive.

    Settings
    Member Visibility

    On This Page
    Properties