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

    Class MetadataApiRetrieve

    Hierarchy

    Index
    DEFAULT_OPTIONS: Partial<MetadataApiRetrieveOptions> = ...
    • Parameters

      • subscriber: (result: Error) => void

      Returns void

    • Poll for the status of the metadata transfer request. Default frequency is 1000ms minimum, scaling with deploy size (zip bytes or component count). Default timeout is 60 minutes.

      Parameters

      • Optionaloptions: Partial<Options>

        Polling options; frequency, timeout, polling function.

      Returns Promise<RetrieveResult>

      The result of the deploy or retrieve.

    • Poll for the status of the metadata transfer request. Default frequency is 1000ms minimum, scaling with deploy size (zip bytes or component count, capped at 10s). Default timeout is 60 minutes.

      Parameters

      • Optionalfrequency: number

        Polling frequency in milliseconds.

      • Optionaltimeout: number

        Polling timeout in seconds.

      Returns Promise<RetrieveResult>

      The result of the deploy or retrieve.

    post