Class SourceComponent

constructor

• new SourceComponent(props, tree?, forceIgnore?): SourceComponent

• Parameters

  • props: ComponentProperties
  • tree: TreeContainer = ...
  • forceIgnore: ForceIgnore = ...

  Returns SourceComponent

Optionalcontent

Readonlyname

Optional Readonlyparent

OptionalparentType

Optionalreplacements

Readonlytype

Optional Readonlyxml

fullName

• get fullName(): string

• Returns string

isAddressable

• get isAddressable(): boolean

• Returns whether this component type is supported by the Metadata API and therefore should have an entry added to the manifest.

  This is defined on the type in the registry. The type is required to be in the registry for proper classification and for possible use in decomposition/recomposition.

  Default value is true, so the only way to return false is to explicitly set it in the registry as false.

  E.g., CustomFieldTranslation.

  Returns boolean

metaFilePath

• get metaFilePath(): undefined | string

• Gets the metafile path of this component. Not all the types have an XML metafile, e.g., DigitalExperience has a JSON metafile (_meta.json).

  Returns undefined | string

  The metafile path

  Deprecated

  This function should not be used, use "xml" property instead.

tree

• get tree(): TreeContainer

• Returns TreeContainer

getChildren

• getChildren(): SourceComponent[]

• returns the children of a parent SourceComponent

  Ensures that the children of SourceComponent are valid child types. Invalid child types can occur when projects are structured in an atypical way such as having ApexClasses or Layouts within a CustomObject folder.

  Returns SourceComponent[]

  SourceComponent[] containing valid children

getDestructiveChangesType

• getDestructiveChangesType(): undefined | DestructiveChangesType

• Returns undefined | DestructiveChangesType

getForceIgnore

• getForceIgnore(): ForceIgnore

• will return this instance of the forceignore, or will create one if undefined

  Returns ForceIgnore

  ForceIgnore

getPackageRelativePath

• getPackageRelativePath(fsPath, format): string

• Parameters

  • fsPath: string
  • format: SfdxFileFormat

  Returns string

isMarkedForDelete

• isMarkedForDelete(): boolean

• Returns boolean

  whether this component should be part of destructive changes.

parseFromParentXml

• parseFromParentXml<T>(parentXml): T

• As a performance enhancement, use the already parsed parent xml source to return the child section of xml source. This is useful for non-decomposed transformers where all child source components reference the parent's xml file to prevent re-reading the same file multiple times.

  Type Parameters

  • T = JsonMap

  Parameters

  • parentXml: T

    parsed parent XMl source as an object

  Returns T

  child section of the parent's xml

parseXml

• parseXml<T>(xmlFilePath?): Promise<T>

• Type Parameters

  • T extends JsonMap

  Parameters

  • OptionalxmlFilePath: string

  Returns Promise<T>

parseXmlSync

• parseXmlSync<T>(xmlFilePath?): T

• Type Parameters

  • T extends JsonMap

  Parameters

  • OptionalxmlFilePath: string

  Returns T

setMarkedForDelete

• setMarkedForDelete(destructiveChangeType?): void

• Parameters

  • OptionaldestructiveChangeType: boolean | DestructiveChangesType

  Returns void

walkContent

• walkContent(): string[]

• Returns string[]

StaticcreateVirtualComponent

• createVirtualComponent(props, fs?, forceIgnore?): SourceComponent

• Parameters

  • props: ComponentProperties

    component properties (at a minimum, name and type)
  • Optionalfs: VirtualDirectory[]

    VirtualTree. If not provided, one will be constructed based on the name/type of the props
  • OptionalforceIgnore: ForceIgnore

  Returns SourceComponent

  SourceComponent