Hierarchy

Constructors

Properties

DEFAULT_OPTIONS: Partial<MetadataApiRetrieveOptions> = ...

Accessors

Methods

  • Parameters

    • subscriber: ((result: Error) => void)
        • (result): void
        • Parameters

          • result: Error

          Returns void

    Returns void

  • Poll for the status of the metadata transfer request. Default frequency is 100 ms. 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 based on the number of SourceComponents, n, in the transfer, it ranges from 100ms -> n 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.