LocalFile
Represents a local file.
This is an alias for the LocalFileUnion type.
chevron_leftchevron_right
Parameters
Interface
| Name | Type | Description |
|---|---|---|
_ | "localFile" | |
path | string | Local path to the locally available file part; may be empty |
canBeDownloaded | boolean | True, if it is possible to download or generate the file |
canBeDeleted | boolean | True, if the file can be deleted |
isDownloadingActive | boolean | True, if the file is currently being downloaded (or a local copy is being generated by some other means) |
isDownloadingCompleted | boolean | True, if the local copy is fully available |
downloadOffset | number | Download will be started from this offset. downloaded_prefix_size is calculated from this offset |
downloadedPrefixSize | number | If is_downloading_completed is false, then only some prefix of the file starting from download_offset is ready to be read. downloaded_prefix_size is the size of that prefix in bytes |
downloadedSize | number | Total downloaded file size, in bytes. Can be used only for calculating download progress. The actual file size may be bigger, and some parts of it may contain garbage |