Skip to main content

Function: pullImage()

pullImage(containerProviderConnection, imageName, callback, platform?, token?): Promise<void>

Defined in: packages/extension-api/src/extension-api.d.ts:4162

Pull an image from a registry

Parameters​

containerProviderConnection​

ContainerProviderConnection

the connection to the local engine to use for pulling the image

imageName​

string

the name of the image to pull

callback​

(event) => void

the function called when new logs are emitted during the pull operation

platform?​

string

the platform of the image to pull (optional, by default it will pull the same architecture as the host)

token?​

CancellationToken

an optional CancellationToken to cancel the pull operation

Returns​

Promise<void>