Class Node

Class representing a node

Hierarchy

Node

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

- Defined in node.ts:11
Create a node

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

Properties

data

data: Object

id

id: String

modem

modem: Modem

Methods

remove

remove(opts: Object): Promise<__type>

- Defined in node.ts:86
Remove a node https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/remove-a-node

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

Promise return the result

status

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

- Defined in node.ts:58
Get low-level information on a node https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/inspect-a-node 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<Object>

Promise return the node

update

update(opts?: Object): Promise<Node>

- Defined in node.ts:29
Update a node https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/update-a-node

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

Promise return the new node

Generated using TypeDoc