Class ComponentSet

constructor

• new ComponentSet(components?, registry?): ComponentSet

• Parameters

  • components: Iterable<ComponentLike> = []
  • registry: RegistryAccess = ...

  Returns ComponentSet

OptionalapiVersion

OptionalforceIgnoredPaths

OptionalfullName

OptionalprojectDirectory

OptionalsourceApiVersion

Static ReadonlyWILDCARD

destructiveChangesPost

• get destructiveChangesPost(): DecodeableMap<string, DecodeableMap<string, SourceComponent>>

• Returns DecodeableMap<string, DecodeableMap<string, SourceComponent>>

destructiveChangesPre

• get destructiveChangesPre(): DecodeableMap<string, DecodeableMap<string, SourceComponent>>

• Returns DecodeableMap<string, DecodeableMap<string, SourceComponent>>

size

• get size(): number

• Each SourceComponent counts as an element in the set, even if multiple ones map to the same fullName and type pair.

  Returns number

  number of metadata components in the set

[iterator]

• [iterator](): Iterator<MetadataComponent, any, undefined>

• USE getIterator() IN METHOD IMPLEMENTATIONS

  This is to support for..of syntax on non-subclass instances of LazyCollection. getIterator() ensures we use [Symbol.iterator] of the subclass if iterable is not set.

  Returns Iterator<MetadataComponent, any, undefined>

add

• add(component, deletionType?): void

• Parameters

  • component: ComponentLike
  • OptionaldeletionType: DestructiveChangesType

  Returns void

deploy

• deploy(options): Promise<MetadataApiDeploy>

• Constructs a deploy operation using the components in the set and starts the deployment. There must be at least one source-backed component in the set to create an operation.

  Parameters

  • options: DeploySetOptions

  Returns Promise<MetadataApiDeploy>

  Metadata API deploy operation

getComponentFilenamesByNameAndType

• getComponentFilenamesByNameAndType(param): string[]

• For a fullName and type, this returns the filenames the matching component, or an empty array if the component is not present

  Parameters

  • param: MetadataMember

    Object with fullName and type properties

  Returns string[]

  string[]

getDestructiveChangesType

• getDestructiveChangesType(): DestructiveChangesType

• If this ComponentSet has components marked for delete it will use this type to build the appropriate destructive changes manifest.

  Returns DestructiveChangesType

  The type of destructive changes to make; i.e., pre or post deploy.

getObject

• getObject(destructiveType?): Promise<PackageManifestObject>

• Get an object representation of a package manifest based on the set components.

  Parameters

  • OptionaldestructiveType: DestructiveChangesType

    Optional value for generating objects representing destructive change manifests

  Returns Promise<PackageManifestObject>

  Object representation of a package manifest

getPackageXml

• getPackageXml(indentation?, destructiveType?): Promise<string>

• Create a manifest in xml format based on the set components and the type of manifest to create.

  E.g. package.xml or destructiveChanges.xml

  Parameters

  • indentation: number = 4

    Number of spaces to indent lines by.
  • OptionaldestructiveType: DestructiveChangesType

    What type of destructive manifest to build.

  Returns Promise<string>

getSourceComponents

• getSourceComponents(member?): LazyCollection<SourceComponent>

• Get only the source-backed metadata components in the set.

  Parameters

  • Optionalmember: ComponentLike

    Member to retrieve source-backed components for.

  Returns LazyCollection<SourceComponent>

  Collection of source-backed components

getTypesOfDestructiveChanges

• getTypesOfDestructiveChanges(): DestructiveChangesType[]

• Will return the types of destructive changes in the component set or an empty array if there aren't destructive components present

  Returns DestructiveChangesType[]

  DestructiveChangesType[]

has

• has(component): boolean

• Tests whether or not a fullName and type pair is present in the set.

  A pair is considered present in the set if one of the following criteria is met:

  • The pair is directly in the set, matching the component key "as is" or decoded.
  • A wildcard component with the same type as the pair
  • If a parent is attached to the pair and the parent is directly in the set
  • If a parent is attached to the pair, and a wildcard component's type matches the parent's type

  Parameters

  • component: ComponentLike

    Component to test for membership in the set

  Returns boolean

  true if the component is in the set

retrieve

• retrieve(options): Promise<MetadataApiRetrieve>

• Constructs a retrieve operation using the components in the set and starts the retrieval.

  Parameters

  • options: RetrieveSetOptions

  Returns Promise<MetadataApiRetrieve>

  Metadata API retrieve operation

setDestructiveChangesType

• setDestructiveChangesType(type): void

• If this ComponentSet has components marked for delete, this sets whether those components are deleted before any other changes are deployed (destructiveChangesPre.xml) or after changes are deployed (destructiveChangesPost.xml).

  Parameters

  • type: DestructiveChangesType

    The type of destructive changes to make; i.e., pre or post deploy.

  Returns void

StaticfromConnection

• fromConnection(username): Promise<ComponentSet>

• Resolve components from an org connection.

  Parameters

  • username: string

    org connection username

  Returns Promise<ComponentSet>

  ComponentSet of source resolved components
• fromConnection(options): Promise<ComponentSet>

• Resolve components from an org connection.

  Parameters

  • options: FromConnectionOptions

  Returns Promise<ComponentSet>

  ComponentSet of source resolved components

StaticfromManifest

• fromManifest(manifestPath): Promise<ComponentSet>

• Resolve components from a manifest file in XML format.

  see Sample package.xml Manifest Files

  Parameters

  • manifestPath: string

    Path to XML file

  Returns Promise<ComponentSet>

  Promise of a ComponentSet containing manifest components
• fromManifest(options): Promise<ComponentSet>

• Resolve components from a manifest file in XML format. Customize the resolution process using an options object. For example, resolve source-backed components while using the manifest file as a filter. process using an options object, such as resolving source-backed components and using the manifest file as a filter.

  see Sample package.xml Manifest Files

  Parameters

  • options: FromManifestOptions

  Returns Promise<ComponentSet>

  Promise of a ComponentSet containing manifest components

StaticfromSource

• fromSource(fsPath): ComponentSet

• Resolve metadata components from a file or directory path in a file system.

  Parameters

  • fsPath: string

    File or directory path to resolve against

  Returns ComponentSet

  ComponentSet of source resolved components
• fromSource(fsPaths): ComponentSet

• Resolve metadata components from multiple file paths or directory paths in a file system.

  Parameters

  • fsPaths: string[]

    File or directory paths to resolve against

  Returns ComponentSet

  ComponentSet of source resolved components
• fromSource(options): ComponentSet

• Resolve metadata components from file or directory paths in a file system. Customize the resolution process using an options object, such as specifying filters and resolving against a different file system abstraction (see TreeContainer).

  Parameters

  • options: FromSourceOptions

  Returns ComponentSet

  ComponentSet of source resolved components