Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • FileDownload

Index

Properties

attachments: number

Number of downloaded attachments (for DocumentReferences)

completed: boolean

true if the file has been fully downloaded

downloadedBytes: number

Number of bytes downloaded

downloadedChunks: number

Number of chunks received (downloaded as stream with chunked encoding)

error: null | Error

Download processing error (if any)

exportType: "error" | "output" | "deleted"

The value shows which part of the manifest this download comes from. Can be:

  • "output" - For exported files
  • "deleted" - The "deleted" bundles
  • "error" - For ndjson files with error operation outcomes
name: string

The file display name (typically the URL basename)

resources: number

Number of FHIR resources in the file (applicable for FHIR NDJSON)

running: boolean

true if the file is currently being downloaded

type: string

The FHIR resourceType

uncompressedBytes: number

Number of bytes after decompression. If the response is compressed, this will be greater than downloadedBytes

url: string

The file URL

Generated using TypeDoc