Class default

Hierarchy

default

Index

Constructors

constructor

Properties

modem

Methods

Constructors

constructor

new default(modem: Modem): default

- Defined in network.ts:138
Parameters
- modem: Modem
Returns default

Properties

modem

modem: Modem

Methods

create

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

- Defined in network.ts:189
Create a network https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/create-a-network

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

Promise return the new network

get

get(id: String): Network

- Defined in network.ts:149
Get a Network object

Parameters
- id: String
Returns Network

list

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

- Defined in network.ts:159
Get the list of networks https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/list-networks

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

Promise returning the result as a list of networks

prune

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

- Defined in network.ts:217
Prune network https://docs.docker.com/engine/api/v1.25/#operation/NetworkPrune

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

Promise returning the container

Generated using TypeDoc