Class Network

Class reprensenting a network

Hierarchy

Network

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

- Defined in network.ts:11
Creates a new network

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

Properties

data

data: Object

id

id: String

modem

modem: Modem

Methods

connect

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

- Defined in network.ts:84
Connect a container into the network https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/connect-a-container-to-a-network

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

Promise return the network

disconnect

disconnect(opts?: Object): Promise<Network>

- Defined in network.ts:113
Disonnect a container into the network https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/disconnect-a-container-from-a-network

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

Promise return the network

remove

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

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

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

Promise return the result

status

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

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

Generated using TypeDoc