@backblaze-labs/b2-sdk - v0.1.0
    Preparing search index...

    Interface DownloadFileOptions

    Options accepted by RawClient.downloadFileById and RawClient.downloadFileByName. Mirrors the B2 native API: range + SSE-C decryption headers + the documented b2Content* response-header overrides (query-string parameters on the request URL).

    interface DownloadFileOptions {
        b2CacheControl?: string;
        b2ContentDisposition?: string;
        b2ContentEncoding?: string;
        b2ContentLanguage?: string;
        b2ContentType?: string;
        b2Expires?: string;
        method?: "GET" | "HEAD";
        range?: string;
        serverSideEncryption?: SseCDownloadKey;
        signal?: AbortSignal;
    }
    Index

    Properties

    b2CacheControl? b2ContentDisposition? b2ContentEncoding? b2ContentLanguage? b2ContentType? b2Expires? method? range? serverSideEncryption? signal?

    Properties

    b2CacheControl?: string

    Override the Cache-Control header in the download response.

    b2ContentDisposition?: string

    Override the Content-Disposition header in the download response.

    b2ContentEncoding?: string

    Override the Content-Encoding header in the download response.

    b2ContentLanguage?: string

    Override the Content-Language header in the download response.

    b2ContentType?: string

    Override the Content-Type header in the download response.

    b2Expires?: string

    Override the Expires header in the download response.

    method?: "GET" | "HEAD"

    HTTP method. Defaults to 'GET'. Use 'HEAD' to fetch headers without the body.

    range?: string

    HTTP Range header value for partial content requests.

    serverSideEncryption?: SseCDownloadKey

    SSE-C decryption parameters, required if the file was uploaded with SSE-C.

    signal?: AbortSignal

    Signal to abort the download.

    Settings

    Member Visibility

    On This Page

    Properties