@salesforce/b2c-tooling-sdk / project-index / CartridgeOrder
Interface: CartridgeOrder
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:226
Where the index's cartridge order came from:
configured: thecartridgePathoption (cartridgesin dw.json orSFCC_CARTRIDGES).instance: a site's cartridge path read from the instance (the caller passed it ascartridgePath).provided: the caller passed ordered cartridges (for example the VS Code Cartridges view order).site-file: a site's<custom-cartridges>in a site import file in the project (sites/<id>/site.xml, the latest by migration or import set timestamp).discovery: a guess: discovery order with known base cartridges last.
Properties
allCartridges?
optionalallCartridges:boolean
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:242
True when every project cartridge was indexed (includeAllCartridges), including those in notOnPath.
file?
optionalfile:string
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:233
For site-file: the file, relative to the project root.
hostname?
optionalhostname:string
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:231
For instance: the instance the path was read from.
notOnPath?
optionalnotOnPath:string[]
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:238
Cartridges in the project that the cartridge path doesn't name. The site doesn't run their code, so they are left out of the index (see ProjectIndex.otherCartridges) unless includeAllCartridges is set.
otherSites?
optionalotherSites:string[]
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:240
For instance and site-file: other sites (on the instance, or in the project) with a different cartridge path.
siteId?
optionalsiteId:string
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:229
For instance and site-file: the site whose path was used.
source
source:
"instance"|"discovery"|"configured"|"provided"|"site-file"
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:227