node-docker-api
Version:
Docker Remote API driver for node
223 lines • 7.35 kB
JavaScript
;
/**
* Class reprensenting a network
*/
class Network {
/**
* Creates a new network
* @param {Modem} modem Modem to connect to the remote service
* @param {string} id Id of the network (optional)
*/
constructor(modem, id) {
this.data = {};
this.modem = modem;
this.id = id;
}
/**
* 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.
* @param {Object} opts Query params in the request (optional)
* @return {Promise} Promise return the network
*/
status(opts) {
const call = {
path: `/networks/${this.id}?`,
method: 'GET',
options: opts,
statusCodes: {
200: true,
404: 'no such network',
500: 'server error'
}
};
return new Promise((resolve, reject) => {
this.modem.dial(call, (err, conf) => {
if (err)
return reject(err);
const network = new Network(this.modem, this.id);
network.data = conf;
resolve(network);
});
});
}
/**
* Remove a network
* https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/remove-a-network
* @param {Object} opts Query params in the request (optional)
* @return {Promise} Promise return the result
*/
remove(opts) {
const call = {
path: `/networks/${this.id}?`,
method: 'DELETE',
options: opts,
statusCodes: {
204: true,
404: 'no such network',
500: 'server error'
}
};
return new Promise((resolve, reject) => {
this.modem.dial(call, (err) => {
if (err)
return reject(err);
resolve();
});
});
}
/**
* Connect a container into the network
* https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/connect-a-container-to-a-network
* @param {Object} opts Query params in the request (optional)
* @return {Promise} Promise return the network
*/
connect(opts) {
const call = {
path: `/networks/${this.id}/connect?`,
method: 'POST',
options: opts,
statusCodes: {
200: true,
403: 'operation not supported for swarm scoped network',
404: 'network or container not found',
500: 'server error'
}
};
return new Promise((resolve, reject) => {
this.modem.dial(call, (err, conf) => {
if (err)
return reject(err);
const network = new Network(this.modem, this.id);
network.data = conf;
resolve(network);
});
});
}
/**
* Disonnect a container into the network
* https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/disconnect-a-container-from-a-network
* @param {Object} opts Query params in the request (optional)
* @return {Promise} Promise return the network
*/
disconnect(opts) {
const call = {
path: `/networks/${this.id}/disconnect?`,
method: 'POST',
options: opts,
statusCodes: {
200: true,
403: 'operation not supported for swarm scoped network',
404: 'network or container not found',
500: 'server error'
}
};
return new Promise((resolve, reject) => {
this.modem.dial(call, (err, conf) => {
if (err)
return reject(err);
const network = new Network(this.modem, this.id);
network.data = conf;
resolve(network);
});
});
}
}
exports.Network = Network;
class default_1 {
constructor(modem) {
this.modem = modem;
}
/**
* Get a Network Object
* @param {id} string ID of the secret
* @return {Network}
*/
get(id) {
return new Network(this.modem, id);
}
/**
* Get the list of networks
* https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/list-networks
* @param {Object} opts Query params in the request (optional)
* @return {Promise} Promise returning the result as a list of networks
*/
list(opts) {
const call = {
path: '/networks?',
method: 'GET',
options: opts,
statusCodes: {
200: true,
500: 'server error'
}
};
return new Promise((resolve, reject) => {
this.modem.dial(call, (err, networks) => {
if (err)
return reject(err);
if (!networks || !networks.length)
return resolve([]);
resolve(networks.map((conf) => {
const network = new Network(this.modem, conf.Id);
network.data = conf;
return network;
}));
});
});
}
/**
* Create a network
* https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/create-a-network
* @param {Object} opts Query params in the request (optional)
* @return {Promise} Promise return the new network
*/
create(opts) {
const call = {
path: '/networks/create?',
method: 'POST',
options: opts,
statusCodes: {
201: true,
404: 'plugin not found',
500: 'server error'
}
};
return new Promise((resolve, reject) => {
this.modem.dial(call, (err, conf) => {
if (err)
return reject(err);
const network = new Network(this.modem, conf.Id);
network.data = conf;
resolve(network);
});
});
}
/**
* Prune network
* https://docs.docker.com/engine/api/v1.25/#operation/NetworkPrune
* @param {Object} opts Query params in the request (optional)
* @return {Promise} Promise returning the container
*/
prune(opts) {
const call = {
path: `/networks/prune`,
method: 'POST',
options: opts,
statusCodes: {
200: true,
500: 'server error'
}
};
return new Promise((resolve, reject) => {
this.modem.dial(call, (err, res) => {
if (err)
return reject(err);
resolve(res);
});
});
}
}
Object.defineProperty(exports, "__esModule", { value: true });
exports.default = default_1;
//# sourceMappingURL=network.js.map