Class MetadataApiDeploy

constructor

• new MetadataApiDeploy(options): MetadataApiDeploy

• Parameters

  • options: MetadataApiDeployOptions

  Returns MetadataApiDeploy

Static ReadonlyDEFAULT_OPTIONS

cancel

• cancel(): Promise<void>

• Cancel the deploy operation.

  Deploys are asynchronously canceled. Once the cancel request is made to the org, check the status of the cancellation with checkStatus.

  Returns Promise<void>

checkStatus

• checkStatus(): Promise<MetadataApiDeployStatus>

• Check the status of the deploy operation.

  Returns Promise<MetadataApiDeployStatus>

  Status of the deploy

deployRecentValidation

• deployRecentValidation(rest?): Promise<string>

• Deploy recently validated components without running Apex tests. Requires the operation to have been created with the { checkOnly: true } API option.

  Ensure that the following requirements are met before deploying a recent validation:

  • The components have been validated successfully for the target environment within the last 10 days.
  • As part of the validation, Apex tests in the target org have passed.
  • Code coverage requirements are met.
  • If all tests in the org or all local tests are run, overall code coverage is at least 75%, and Apex triggers have some coverage.
  • If specific tests are run with the RunSpecifiedTests test level, each class and trigger that was deployed is covered by at least 75% individually.

  See deployRecentValidation()

  Parameters

  • rest: boolean = false

    Set to true to use the REST API, otherwise defaults to using SOAP

  Returns Promise<string>

  The ID of the quick deployment