> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# DownloadFilesRequest

> DownloadFilesRequest — Kinetica Node.js API

interface DownloadFilesRequest \{\
&#x20;[file\_names](#file_names): string\[];\
&#x20;[options](#options)?: Record\<string, string>;\
&#x20;[read\_lengths](#read_lengths): number\[];\
&#x20;[read\_offsets](#read_offsets): number\[];\
}

<ul>
  <li>Defined in [src/types.ts:2324](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2324)</li>
</ul>

##### Index

### Properties

[file\_names](#file_names) [options?](#options) [read\_lengths](#read_lengths) [read\_offsets](#read_offsets)&#x20;

## Properties

### file\_names

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.

<ul>
  <li>Defined in [src/types.ts:2333](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2333)</li>
</ul>

### `Optional`options

options?: Record\<string, string>

Optional parameters.

<ul>
  <li>Defined in [src/types.ts:2349](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2349)</li>
</ul>

### read\_lengths

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.

<ul>
  <li>Defined in [src/types.ts:2347](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2347)</li>
</ul>

### read\_offsets

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.

<ul>
  <li>Defined in [src/types.ts:2340](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2340)</li>
</ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.