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

    Interface DownloadHeaders

    Parsed headers from a B2 file download response.

    interface DownloadHeaders {
        cacheControl?: string;
        clientUnauthorizedToRead?: readonly DownloadClientUnauthorizedToReadMarker[];
        contentDisposition?: string;
        contentEncoding?: string;
        contentLanguage?: string;
        contentLength: number;
        contentRange?: string;
        contentSha1: string | null;
        contentType: string;
        expires?: string;
        fileId: FileId;
        fileInfo: Record<string, string>;
        fileName: string;
        fileRetention?: ReadableFileRetention;
        headerParseIssues?: readonly DownloadHeaderParseIssue[];
        legalHold?: ReadableLegalHold;
        serverSideEncryption?: DownloadServerSideEncryption;
        uploadTimestamp: number;
    }
    Index
    cacheControl? clientUnauthorizedToRead? contentDisposition? contentEncoding? contentLanguage? contentLength contentRange? contentSha1 contentType expires? fileId fileInfo fileName fileRetention? headerParseIssues? legalHold? serverSideEncryption? uploadTimestamp
    cacheControl?: string

    Cache-Control value computed from upload metadata, bucket defaults, or the download request.

    clientUnauthorizedToRead?: readonly DownloadClientUnauthorizedToReadMarker[]

    Header names B2 omitted because the caller lacks capability to read them.

    contentDisposition?: string

    Content-Disposition value computed from upload metadata or the download request.

    contentEncoding?: string

    Content-Encoding value computed from upload metadata or the download request.

    contentLanguage?: string

    Content-Language value computed from upload metadata or the download request.

    contentLength: number

    Size of the downloaded content in bytes.

    contentRange?: string

    Content-Range value returned for satisfiable range downloads.

    contentSha1: string | null

    SHA-1 checksum of the full file content, or null for large files.

    contentType: string

    MIME type of the downloaded file content.

    expires?: string

    Expires value computed from upload metadata or the download request.

    fileId: FileId

    ID of the downloaded file version.

    fileInfo: Record<string, string>

    User-defined key-value metadata stored with the file.

    fileName: string

    Full path and name of the downloaded file.

    fileRetention?: ReadableFileRetention

    Object Lock retention metadata, including whether the caller may read it.

    headerParseIssues?: readonly DownloadHeaderParseIssue[]

    Present metadata headers the SDK could not parse into its current narrow typed model.

    legalHold?: ReadableLegalHold

    Object Lock legal hold metadata, including whether the caller may read it.

    serverSideEncryption?: DownloadServerSideEncryption

    Server-side encryption metadata echoed by B2, when the caller is authorized to read it.

    uploadTimestamp: number

    UTC timestamp (milliseconds) when the file was uploaded.

    Settings
    Member Visibility

    On This Page
    Properties