Skip to main content
interface DownloadFilesRequest
file_names: string[];
options?: Record<string, string>;
read_lengths: number[];
read_offsets: number[];
file_names options? read_lengths read_offsets
file_names: string[]

An array of the file names to download from KiFS. File paths may contain wildcard characters after the KiFS directory delimiter.

Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character.

options?: Record<string, string>

Optional parameters.

read_lengths: number[]

Array of number of bytes to read from each respective file in file_names. Must either be empty or the same length as file_names. If empty, files are downloaded in their entirety. If not empty, read_offsets must also not be empty.

read_offsets: number[]

An array of starting byte offsets from which to read each respective file in file_names. Must either be empty or the same length as file_names. If empty, files are downloaded in their entirety. If not empty, read_lengths must also not be empty.