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

Function: deleteCartridges()

deleteCartridges(instance, cartridges): Promise<void>

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

Deletes cartridges from an instance via WebDAV.

This is a low-level function that deletes cartridge directories from the specified code version. Errors are silently ignored for cartridges that don't exist.

Requires instance.config.codeVersion to be set.

Parameters

instance

B2CInstance

B2C instance to delete from

cartridges

CartridgeMapping[]

Cartridge mappings to delete

Returns

Promise<void>

Throws

Error if code version not set

Example

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