Class default

Hierarchy

default

Index

Constructors

constructor

Properties

modem

Methods

get
list

Constructors

constructor

new default(modem: Modem): default

- Defined in node.ts:108
Create a node

Parameters
- modem: Modem
  
  Modem to connect to the remote service
Returns default

Properties

modem

modem: Modem

Methods

get

get(id: String): Node

- Defined in node.ts:123
Get a Node object

Parameters
- id: String
Returns Node

list

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

- Defined in node.ts:133
Get the list of nodes https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/list-nodes

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

Promise returning the result as a list of nodes

Generated using TypeDoc