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

Function: watchCartridges()

watchCartridges(instance, directory, options): Promise<WatchResult>

Defined in: packages/b2c-tooling-sdk/src/operations/code/watch.ts:91

Watches cartridge directories and syncs changes to an instance.

This function:

1. Finds cartridges in the specified directory
2. Sets up file watchers on those directories
3. Batches file changes and uploads them via WebDAV
4. Handles file deletions

The watcher uses debouncing to batch rapid changes into single uploads.

Parameters

instance

B2CInstance

B2C instance to sync to

directory

string

Directory containing cartridges

options

WatchOptions = {}

Watch options (filters, callbacks, debounce)

Returns

Promise<WatchResult>

Watch result with control methods

Throws

Error if no cartridges found or watch setup fails

Example

const result = await watchCartridges(instance, './cartridges', {
  onUpload: (files) => console.log('Uploaded:', files),
  onError: (error) => console.error('Error:', error),
});

// Later, to stop watching:
await result.stop();