Class Exec

Class representing container execution

Hierarchy

Exec

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Exec(modem: Modem, container: Container, id: String): Exec

- Defined in container.ts:15
Create an execution

Parameters
- modem: Modem
  
  Modem to connect to the remote service
- container: Container
  
  Container that owns the execution (optional)
- id: String
  
  Id of the execution
Returns Exec

Properties

container

container: Container

data

data: Object

id

id: String

modem

modem: Modem

Methods

create

create(opts?: Object): Promise<Exec>

- Defined in container.ts:36
Create an exec instance in a container https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/create-a-container

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

Promise return the new exec instance

resize

resize(opts?: Object): Promise<__type>

- Defined in container.ts:95
Resize an exec instance https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/exec-resize

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

Promise return the result

start

start(opts?: any): Promise<Object>

- Defined in container.ts:66
Start an exec instance https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/exec-start

Parameters
- Default value opts: any = {}
  
  Query params in the request (optional)
Returns Promise<Object>

Promise return the stream to the execution

status

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

- Defined in container.ts:121
Get status of an exec instance https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/exec-inspect 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<Exec>

Promise return the exec instance

Generated using TypeDoc