| 1 | import Modem = require('docker-modem');
|
| 2 | /**
|
| 3 | * Class reprensenting a network
|
| 4 | */
|
| 5 | export declare class Network {
|
| 6 | modem: Modem;
|
| 7 | id: String;
|
| 8 | data: Object;
|
| 9 | /**
|
| 10 | * Creates a new network
|
| 11 | * @param {Modem} modem Modem to connect to the remote service
|
| 12 | * @param {string} id Id of the network (optional)
|
| 13 | */
|
| 14 | constructor(modem: Modem, id: String);
|
| 15 | /**
|
| 16 | * Get low-level information on a network
|
| 17 | * https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/inspect-network
|
| 18 | * The reason why this module isn't called inspect is because that interferes with the inspect utility of node.
|
| 19 | * @param {Object} opts Query params in the request (optional)
|
| 20 | * {Promise} Promise return the network
|
| 21 | */
|
| 22 | status(opts?: Object): Promise<{}>;
|
| 23 | /**
|
| 24 | * Remove a network
|
| 25 | * https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/remove-a-network
|
| 26 | * @param {Object} opts Query params in the request (optional)
|
| 27 | * @return {Promise} Promise return the result
|
| 28 | */
|
| 29 | remove(opts?: Object): Promise<{}>;
|
| 30 | /**
|
| 31 | * Connect a container into the network
|
| 32 | * https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/connect-a-container-to-a-network
|
| 33 | * @param {Object} opts Query params in the request (optional)
|
| 34 | * @return {Promise} Promise return the network
|
| 35 | */
|
| 36 | connect(opts?: Object): Promise<{}>;
|
| 37 | /**
|
| 38 | * Disonnect a container into the network
|
| 39 | * https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/disconnect-a-container-from-a-network
|
| 40 | * @param {Object} opts Query params in the request (optional)
|
| 41 | * @return {Promise} Promise return the network
|
| 42 | */
|
| 43 | disconnect(opts?: Object): Promise<Network>;
|
| 44 | }
|
| 45 | export default class {
|
| 46 | modem: Modem;
|
| 47 | constructor(modem: Modem);
|
| 48 | /**
|
| 49 | * Get a Network object
|
| 50 | * @param {id} string ID of the secret
|
| 51 | * {Network}
|
| 52 | */
|
| 53 | get(id: String): Network;
|
| 54 | /**
|
| 55 | * Get the list of networks
|
| 56 | * https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/list-networks
|
| 57 | * @param {Object} opts Query params in the request (optional)
|
| 58 | * @return {Promise} Promise returning the result as a list of networks
|
| 59 | */
|
| 60 | list(opts?: Object): Promise<Array<Network>>;
|
| 61 | /**
|
| 62 | * Create a network
|
| 63 | * https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/create-a-network
|
| 64 | * @param {Object} opts Query params in the request (optional)
|
| 65 | * @return {Promise} Promise return the new network
|
| 66 | */
|
| 67 | create(opts?: Object): Promise<Network>;
|
| 68 | /**
|
| 69 | * Prune network
|
| 70 | * https://docs.docker.com/engine/api/v1.25/#operation/NetworkPrune
|
| 71 | * @param {Object} opts Query params in the request (optional)
|
| 72 | * @return {Promise} Promise returning the container
|
| 73 | */
|
| 74 | prune(opts?: Object): Promise<Object>;
|
| 75 | }
|