@salesforce/b2c-tooling-sdk / operations/code / DownloadOptions

Interface: DownloadOptions

Defined in: packages/b2c-tooling-sdk/src/operations/code/download.ts:29

Options for downloading cartridges.

Properties

exclude?

optional exclude: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/code/download.ts:33

Cartridge names to exclude

---

include?

optional include: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/code/download.ts:31

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:35

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:37

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

Parameters

info

DownloadProgressInfo

Returns

void