---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../../modules.md) / [operations/code](../index.md) / DownloadOptions

# Interface: DownloadOptions

Defined in: [packages/b2c-tooling-sdk/src/operations/code/download.ts:28](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/code/download.ts#L28)

Options for downloading cartridges.

## Properties

### exclude?

> `optional` **exclude**: `string`[]

Defined in: [packages/b2c-tooling-sdk/src/operations/code/download.ts:34](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/code/download.ts#L34)

Cartridge names to exclude

***

### include?

> `optional` **include**: `string`[]

Defined in: [packages/b2c-tooling-sdk/src/operations/code/download.ts:32](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/code/download.ts#L32)

Cartridge names to include (if empty/undefined, all are included)

***

### mirror?

> `optional` **mirror**: `Map`\<`string`, `string`\>

Defined in: [packages/b2c-tooling-sdk/src/operations/code/download.ts:36](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/code/download.ts#L36)

When provided, maps cartridge names to local paths for mirror extraction

***

### onProgress()?

> `optional` **onProgress**: (`info`) => `void`

Defined in: [packages/b2c-tooling-sdk/src/operations/code/download.ts:38](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/code/download.ts#L38)

Callback for progress updates. Called when a phase starts (elapsedSeconds=0) and periodically thereafter.

#### Parameters

##### info

[`DownloadProgressInfo`](DownloadProgressInfo.md)

#### Returns

`void`

***

### scriptsBackend?

> `optional` **scriptsBackend**: [`ScriptsBackend`](ScriptsBackend.md)

Defined in: [packages/b2c-tooling-sdk/src/operations/code/download.ts:30](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/code/download.ts#L30)

Explicit code-version backend. Defaults to OCAPI for SDK compatibility.