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

Function: downloadSingleCartridge()

downloadSingleCartridge(instance, codeVersion, cartridgeName, outputPath, onProgress?): Promise<void>

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

Downloads a single cartridge from an instance via WebDAV.

This is more efficient than downloading the entire code version when only one cartridge is needed, as it ZIPs only the cartridge subdirectory on the server.

Parameters

instance

B2CInstance

B2C instance to download from

codeVersion

string

Code version containing the cartridge

cartridgeName

string

Name of the cartridge to download

outputPath

string

Local path to extract the cartridge into

onProgress?

(info) => void

Optional progress callback

Returns

Promise<void>