Class Task

Class representing a task

Hierarchy

Task

Index

Constructors

constructor

Properties

Methods

status

Constructors

constructor

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

- Defined in task.ts:11
Create a task

Parameters
- modem: Modem
  
  Modem to connect to the remote service
- id: String
  
  Id of the task (optional)
Returns Task

Properties

data

data: Object

id

id: String

modem

modem: Modem

Methods

status

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

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

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

Promise return the task

Generated using TypeDoc