@salesforce/b2c-tooling-sdk / project-index / BuildProjectIndexOptions
Interface: BuildProjectIndexOptions
Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:52
Options for buildProjectIndex.
Properties
cartridgePath?
optionalcartridgePath:string[]
Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:68
Cartridge path order (names), applied to discovered cartridges.
cartridgePathSource?
optionalcartridgePathSource:CartridgeOrder
Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:73
Where cartridgePath came from, reported as ProjectIndex.cartridgeOrder. Defaults to {source: 'configured'}; pass {source: 'instance', siteId, hostname} for a path read from an instance.
cartridges?
optionalcartridges:CartridgeLocation[]
Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:58
Cartridges to index, in cartridge path order. Overrides discovery.
detectSitePath?
optionaldetectSitePath:boolean
Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:79
Without cartridgePath or cartridges, order by a site cartridge path found in the project's site import files (sites/<id>/site.xml, the latest by migration or import set timestamp). Defaults to true.
host?
optionalhost:CartridgeFileSystemHost
Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:82
includeAllCartridges?
optionalincludeAllCartridges:boolean
Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:64
Index every cartridge in the project, not just those on the cartridge path: path cartridges first in path order, then the rest in discovery order (as if the site ran them all). notOnPath is still reported. Defaults to false.
otherCartridges?
optionalotherCartridges:CartridgeLocation[]
Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:66
With cartridges: cartridges in the project that aren't on the path, reported as ProjectIndex.otherCartridges.
paths?
optionalpaths:string[]
Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:56
Additional directories to search for cartridges.
root?
optionalroot:string
Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:54
Directory to search for cartridges when cartridges is not given. Defaults to the current directory.
siteId?
optionalsiteId:string
Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:81
Site whose site.xml cartridge path to use; defaults to the best match.