Skip to content

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

Interface: WatchOptions ​

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

Options for watching cartridges.

Extends ​

Properties ​

debounceTime? ​

optional debounceTime: number

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

Debounce time in ms for batching file changes


exclude? ​

optional exclude: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/code/cartridges.ts:28

Cartridge names to exclude

Inherited from ​

FindCartridgesOptions.exclude


include? ​

optional include: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/code/cartridges.ts:26

Cartridge names to include (if empty, all are included)

Inherited from ​

FindCartridgesOptions.include


onDelete()? ​

optional onDelete: (files) => void

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

Callback when files are deleted

Parameters ​

files ​

string[]

Returns ​

void


onError()? ​

optional onError: (error) => void

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

Callback on error

Parameters ​

error ​

Error

Returns ​

void


onUpload()? ​

optional onUpload: (files) => void

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

Callback when files are uploaded

Parameters ​

files ​

string[]

Returns ​

void

Released under the Apache-2.0 License.