Class Image

Class representing an image

Hierarchy

Image

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Image(modem: Modem, id: String): Image

- Defined in image.ts:12
Creates a new image

Parameters
- modem: Modem
  
  Modem to connect to the remote service
- id: String
  
  Container id
Returns Image

Properties

data

data: Object

id

id: String

modem

modem: Modem

Methods

get

get(opts?: Object): Promise<Object>

- Defined in image.ts:171
Get an image in a tarball https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/get-a-tarball-containing-all-images-in-a-repository

Parameters
- Optional opts: Object
  
  Query params in the request (optional)
Returns Promise<Object>

Promise return the stream with the tarball

history

history(opts?: Object): Promise<Array<Object>>

- Defined in image.ts:60
History of the image https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/get-the-history-of-an-image

Parameters
- Optional opts: Object
  
  Query params in the request (optional)
Returns Promise<Array<Object>>

Promise return the events in the history

push

push(auth?: Object, opts?: Object): Promise<Object>

- Defined in image.ts:87
Push an image to the registry https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/push-an-image-on-the-registry

Parameters
- Optional auth: Object
  
  Authentication (optional)
- Optional opts: Object
  
  Query params in the request (optional)
Returns Promise<Object>

Promise return the resulting stream

remove

remove(opts?: Object): Promise<Array<Object>>

- Defined in image.ts:144
Remove an image from the filesystem https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/remove-an-image

Parameters
- Optional opts: Object
  
  Query params in the request (optional)
Returns Promise<Array<Object>>

Promise return the result

status

status(opts?: Object): Promise<Image>

- Defined in image.ts:31
Get low-level information on an image https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/inspect-an-image The reason why this module isn't called inspect is because that interferes with the inspect utility of node.

Parameters
- Optional opts: Object
  
  Query params in the request (optional)
Returns Promise<Image>

Promise return the image

tag

tag(opts?: Object): Promise<Image>

- Defined in image.ts:115
Tag the image into the registry https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/tag-an-image-into-a-repository

Parameters
- Optional opts: Object
  
  Query params in the request (optional)
Returns Promise<Image>

Promise return the image

Generated using TypeDoc