@salesforce/b2c-tooling-sdk / operations/code / FindCartridgesOptions
Interface: FindCartridgesOptions
Defined in: packages/b2c-tooling-sdk/src/operations/code/cartridges.ts:24
Options for finding cartridges.
Extended by
Properties
exclude?
optionalexclude:string[]
Defined in: packages/b2c-tooling-sdk/src/operations/code/cartridges.ts:28
Cartridge names to exclude
firstMatchOnly?
optionalfirstMatchOnly:boolean
Defined in: packages/b2c-tooling-sdk/src/operations/code/cartridges.ts:46
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.
include?
optionalinclude:string[]
Defined in: packages/b2c-tooling-sdk/src/operations/code/cartridges.ts:26
Cartridge names to include (if empty, all are included)
maxDepth?
optionalmaxDepth: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.