resolveRetrieveDestination
resolveRetrieveDestination(
directory?,projectDir?):Promise<string>
Defined in: resolveSiteFiles.ts:66
Resolve the single directory a retrieve should write into, when the site file wasn’t found among resolveSearchRoots’s (possibly multiple) roots.
Unlike search, retrieval needs exactly one destination: --directory if given, otherwise the
project’s default package directory — the same directory a plain sf project retrieve start
would use absent other guidance.
Parameters
Section titled “Parameters”directory?
Section titled “directory?”string
The --directory flag value, if given.
projectDir?
Section titled “projectDir?”string = ...
Directory to read sfdx-project.json from. Defaults to the current working
directory, matching readSfdxProject.
Returns
Section titled “Returns”Promise<string>
The absolute destination directory.
Throws
Section titled “Throws”CommunityUrlNoRetrieveDestinationError if --directory wasn’t given and the
project has no default package directory to fall back to.