Skip to content

deployMetadataFile

deployMetadataFile(connection, filePath, wait): Promise<DeployMetadataFileResult>

Defined in: packages/simply-aep-core/src/at4dxDomainProcessDeploy.ts:54

Deploy exactly one metadata file and poll until the deploy reaches a terminal state.

Structurally the same as packages/simply-community/src/common/deployChangedFiles.ts (build a ComponentSet.fromSource, deploy, poll, map file responses to failures) but scoped to a single file and kept local to this package rather than imported cross-package — see docs/design/0012-at4dx-domain-process-binding-create-set.md’s Alternatives considered for why this isn’t hoisted into a shared package.

Does not throw on a failed deploy — a failure is reported via success: false/failures so the caller can decide how to surface it (at4dxDomainProcessWrite.ts turns it into a DomainProcessBindingWriteError). An error here means the deploy request or polling itself broke (auth, network, timeout), not that the component failed to deploy.

Connection

The org connection to deploy against.

string

The single .md-meta.xml file to deploy.

Duration

How long to poll before giving up.

Promise<DeployMetadataFileResult>

The deploy outcome: id, terminal status, and any per-component failures.