Optional apiOptional forceOptional fullOptional projectUsed to explicitly set the project directory for the component set. +
Optional apiThe metadata API version to use. E.g., 52.0
+Optional forceOptional fullOptional projectUsed to explicitly set the project directory for the component set. When not present, sfdx-core's SfProject will use the current working directory.
-Optional sourceThe metadata API version of the deployed/retrieved source. +
Optional sourceThe metadata API version of the deployed/retrieved source.
This is used as the value for the version field in the manifest.
Static Readonly WILDCARDEach SourceComponent counts as an element in the set, even if multiple +
Static Readonly WILDCARDEach SourceComponent counts as an element in the set, even if multiple
ones map to the same fullName and type pair.
number of metadata components in the set
-USE getIterator() IN METHOD IMPLEMENTATIONS
+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.
Optional deletionType: DestructiveChangesTypeConstructs a deploy operation using the components in the set and starts +
Optional deletionType: DestructiveChangesTypeConstructs 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.
Metadata API deploy operation
-For a fullName and type, this returns the filenames the matching component, or an empty array if the component is not present
+For a fullName and type, this returns the filenames the matching component, or an empty array if the component is not present
Object with fullName and type properties
string[]
-If this ComponentSet has components marked for delete it will use this
+
If this ComponentSet has components marked for delete it will use this
type to build the appropriate destructive changes manifest.
The type of destructive changes to make; i.e., pre or post deploy.
-Get an object representation of a package manifest based on the set components.
+Get an object representation of a package manifest based on the set components.
Optional destructiveType: DestructiveChangesTypeOptional value for generating objects representing destructive change manifests
Object representation of a package manifest
-Create a manifest in xml format based on the set components and the +
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
Number of spaces to indent lines by.
-Optional destructiveType: DestructiveChangesTypeGet only the source-backed metadata components in the set.
+Optional destructiveType: DestructiveChangesTypeGet only the source-backed metadata components in the set.
Optional member: ComponentLikeMember to retrieve source-backed components for.
Collection of source-backed components
-Will return the types of destructive changes in the component set +
Will return the types of destructive changes in the component set or an empty array if there aren't destructive components present
DestructiveChangesType[]
-Tests whether or not a fullName and type pair is present in the set.
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:
Component to test for membership in the set
true if the component is in the set
Constructs a retrieve operation using the components in the set and +
Constructs a retrieve operation using the components in the set and starts the retrieval.
Metadata API retrieve operation
-If this ComponentSet has components marked for delete, this sets
+
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).
The type of destructive changes to make; i.e., pre or post deploy.
-Static fromResolve components from an org connection.
+Static fromResolve components from an org connection.
org connection username
ComponentSet of source resolved components
-Resolve components from an org connection.
+Resolve components from an org connection.
ComponentSet of source resolved components
-Static fromResolve components from a manifest file in XML format.
+Static fromResolve components from a manifest file in XML format.
Path to XML file
Promise of a ComponentSet containing manifest components
-Resolve components from a manifest file in XML format. +
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.
Promise of a ComponentSet containing manifest components
-Static fromResolve metadata components from a file or directory path in a file system.
+Static fromResolve metadata components from a file or directory path in a file system.
File or directory path to resolve against
ComponentSet of source resolved components
-Resolve metadata components from multiple file paths or directory paths in a file system.
+Resolve metadata components from multiple file paths or directory paths in a file system.
File or directory paths to resolve against
ComponentSet of source resolved components
-Resolve metadata components from file or directory paths in a file system. +
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).
ComponentSet of source resolved components
-
The metadata API version to use. E.g., 52.0
-