Skip to content
View as Markdown
View as Markdown

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

Function: uploadCartridges()

uploadCartridges(instance, cartridges, options?): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/code/deploy.ts:146

Uploads cartridges to an instance via WebDAV.

This is a low-level upload function that:

  1. Creates a zip archive of the cartridges
  2. Uploads it to WebDAV
  3. Unzips on the server
  4. Cleans up the temporary zip file

Requires instance.config.codeVersion to be set.

Parameters

instance

B2CInstance

B2C instance to upload to

cartridges

CartridgeMapping[]

Cartridge mappings to upload

options?

UploadOptions

Returns

Promise<void>

Throws

Error if code version not set or upload fails

Example

typescript
const cartridges = findCartridges('./cartridges');
await uploadCartridges(instance, cartridges);

Released under the Apache-2.0 License.