Class default

Hierarchy

default

Index

Constructors

constructor

Properties

modem

Methods

Constructors

constructor

new default(modem: Modem): default

- Defined in image.ts:193
Parameters
- modem: Modem
Returns default

Properties

modem

modem: Modem

Methods

build

build(file: ReadStream, opts?: Object): Promise<Object>

- Defined in image.ts:270
Build image from dockerfile https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/build-image-from-a-dockerfile

file

{File} file Dockerfile to build

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

Promise return the resulting stream

create

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

- Defined in image.ts:298
Create an image https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/create-an-image

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

Promise return the resulting stream

get

get(id: String): Image

- Defined in image.ts:204
Get a Image object

Parameters
- id: String
Returns Image

getAll

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

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

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

Promise return the stream with the tarball

list

list(opts?: Object): Promise<Array<Image>>

- Defined in image.ts:239
Get the list of images https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/list-images

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

Promise returning the result as a list of images

load

load(file: ReadStream, opts?: Object): Promise<Object>

- Defined in image.ts:352
Load image from tarball https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/load-a-tarball-with-a-set-of-images-and-tags-into-docker

file

{File} file Tarball to load

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

Promise return the stream with the process

prune

prune(opts?: Object): Promise<String>

- Defined in image.ts:379
Prune images https://docs.docker.com/engine/api/v1.25/#operation/ImagePrune

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

Promise returning the container

search

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

- Defined in image.ts:214
Search an image on Docker Hub https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/search-images

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

Promise return the images

Generated using TypeDoc