When true, stop at the first matching cartridge and return only that one. Useful for existence checks (e.g. workspace-type detection) where the full list is not needed — it lets the underlying scan short-circuit instead of enumerating every .project file. Filters from include/exclude are applied while scanning, so the returned cartridge always satisfies them.

Inherited from

FindCartridgesOptions.firstMatchOnly

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

maxDepth?

optional maxDepth: number

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

Maximum directory depth to recurse when searching for .project files, counted in path segments relative to the search directory (so a cartridge at cartridges/<name>/.project is depth 3). When omitted the search is unbounded (default), preserving behavior for callers that expect a full recursive walk. Bound this for untrusted/broad roots (e.g. an MCP server that may be launched from a home directory) to avoid scanning the whole filesystem tree.

Inherited from

FindCartridgesOptions.maxDepth

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

scriptsBackend?

optional scriptsBackend: ScriptsBackend

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

Explicit code-version backend. Defaults to OCAPI for SDK compatibility.