@salesforce/source-deploy-retrieve
    Preparing search index...

    Type Alias RetrieveOptions

    type RetrieveOptions = {
        format?: SfdxFileFormat;
        merge?: boolean;
        output: SourcePath;
        packageOptions?: PackageOptions;
        rootTypesWithDependencies?: string[];
        singlePackage?: boolean;
        suppressEvents?: boolean;
        unzip?: boolean;
        zipFileName?: string;
    }
    Index
    format? merge? output packageOptions? rootTypesWithDependencies? singlePackage? suppressEvents? unzip? zipFileName?
    format?: SfdxFileFormat

    The file format desired for the retrieved files.

    merge?: boolean

    Whether or not to merge and replace input components with the retrieved versions.

    output: SourcePath

    The directory to retrieve components to. If merge: true, components are only retrieved to output if there wasn't a component to merge with.

    packageOptions?: PackageOptions

    A list of package names to retrieve, or package names and their retrieval locations.

    rootTypesWithDependencies?: string[]

    An array of metadata type names for which related, dependent metadata will be retrieved. Supported values: Bot, AiAgentDefinitionVersion.

    singlePackage?: boolean

    Specifies whether only a single package is being retrieved (true) or not (false). If false, then more than one package is being retrieved.

    suppressEvents?: boolean

    Specifies whether to suppress the <Pre|Post> events

    unzip?: boolean

    Specifies whether to unzip the retrieved zip file. Only applies when format: metadata.

    zipFileName?: string

    The name of the retrieved zip file containing the source from the org. Only applies when format: metadata.

    Settings
    Member Visibility

    On This Page
    Properties