UNPKG

node-docker-api

Version:

Docker Remote API driver for node

github.com/AgustinCB/docker-api

AgustinCB/docker-api

92 lines (44 loc) • 2.17 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
## Class: Plugin Creates a new plugin ### Plugin.list(opts) Get the list of plugins https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/list-plugins **Parameters** **opts**: `Object`, Query params in the request (optional) **Returns**: `Promise`, Promise returning the result as a list of plugins ### Plugin.install(opts) install a plugin https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/install-a-plugin **Parameters** **opts**: `Object`, Query params in the request (optional) **Returns**: `Promise`, Promise return the new plugin ### Plugin.status(opts, id) Get low-level information on a plugin https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/inspect-a-plugin The reason why this module isn't called inspect is because that interferes with the inspect utility of node. **Parameters** **opts**: `Object`, Query params in the request (optional) **id**: `String`, ID of the plugin to inspect, if it's not set, use the id of the object (optional) **Returns**: `Promise`, Promise return the plugin ### Plugin.remove(opts, id) Remove a plugin https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/remove-a-plugin **Parameters** **opts**: `Object`, Query params in the request (optional) **id**: `String`, ID of the plugin to inspect, if it's not set, use the id of the object (optional) **Returns**: `Promise`, Promise return the result ### Plugin.enable(opts, id) Enable a plugin https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/enable-a-plugin **Parameters** **opts**: `Object`, Query params in the request (optional) **id**: `String`, ID of the plugin, if it's not set, use the id of the object (optional) **Returns**: `Promise`, Promise return the plugin ### Plugin.disconnect(opts, id) Disable a plugin https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/disable-a-plugin **Parameters** **opts**: `Object`, Query params in the request (optional) **id**: `String`, ID of the plugin, if it's not set, use the id of the object (optional) **Returns**: `Promise`, Promise return the plugin * * *