| <!doctype html> |
| <html class="default no-js"> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <title>Docker | node-docker-api</title> |
| <meta name="description" content=""> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <link rel="stylesheet" href="../assets/css/main.css"> |
| </head> |
| <body> |
| <header> |
| <div class="tsd-page-toolbar"> |
| <div class="container"> |
| <div class="table-wrap"> |
| <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> |
| <div class="field"> |
| <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> |
| <input id="tsd-search-field" type="text" /> |
| </div> |
| <ul class="results"> |
| <li class="state loading">Preparing search index...</li> |
| <li class="state failure">The search index is not available</li> |
| </ul> |
| <a href="../index.html" class="title">node-docker-api</a> |
| </div> |
| <div class="table-cell" id="tsd-widgets"> |
| <div id="tsd-filter"> |
| <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> |
| <div class="tsd-filter-group"> |
| <div class="tsd-select" id="tsd-filter-visibility"> |
| <span class="tsd-select-label">All</span> |
| <ul class="tsd-select-list"> |
| <li data-value="public">Public</li> |
| <li data-value="protected">Public/Protected</li> |
| <li data-value="private" class="selected">All</li> |
| </ul> |
| </div> |
| <input type="checkbox" id="tsd-filter-inherited" checked /> |
| <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> |
| <input type="checkbox" id="tsd-filter-externals" checked /> |
| <label class="tsd-widget" for="tsd-filter-externals">Externals</label> |
| <input type="checkbox" id="tsd-filter-only-exported" /> |
| <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> |
| </div> |
| </div> |
| <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="tsd-page-title"> |
| <div class="container"> |
| <ul class="tsd-breadcrumb"> |
| <li> |
| <a href="../globals.html">Globals</a> |
| </li> |
| <li> |
| <a href="../modules/_docker_.html">"docker"</a> |
| </li> |
| <li> |
| <a href="_docker_.docker.html">Docker</a> |
| </li> |
| </ul> |
| <h1>Class Docker</h1> |
| </div> |
| </div> |
| </header> |
| <div class="container container-main"> |
| <div class="row"> |
| <div class="col-8 col-content"> |
| <section class="tsd-panel tsd-comment"> |
| <div class="tsd-comment tsd-typography"> |
| <div class="lead"> |
| <p>Docker class with all methods</p> |
| </div> |
| </div> |
| </section> |
| <section class="tsd-panel tsd-hierarchy"> |
| <h3>Hierarchy</h3> |
| <ul class="tsd-hierarchy"> |
| <li> |
| <span class="target">Docker</span> |
| </li> |
| </ul> |
| </section> |
| <section class="tsd-panel-group tsd-index-group"> |
| <h2>Index</h2> |
| <section class="tsd-panel tsd-index-panel"> |
| <div class="tsd-index-content"> |
| <section class="tsd-index-section "> |
| <h3>Constructors</h3> |
| <ul class="tsd-index-list"> |
| <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_docker_.docker.html#constructor" class="tsd-kind-icon">constructor</a></li> |
| </ul> |
| </section> |
| <section class="tsd-index-section "> |
| <h3>Properties</h3> |
| <ul class="tsd-index-list"> |
| <li class="tsd-kind-property tsd-parent-kind-class"><a href="_docker_.docker.html#container" class="tsd-kind-icon">container</a></li> |
| <li class="tsd-kind-property tsd-parent-kind-class"><a href="_docker_.docker.html#image" class="tsd-kind-icon">image</a></li> |
| <li class="tsd-kind-property tsd-parent-kind-class"><a href="_docker_.docker.html#modem" class="tsd-kind-icon">modem</a></li> |
| <li class="tsd-kind-property tsd-parent-kind-class"><a href="_docker_.docker.html#network" class="tsd-kind-icon">network</a></li> |
| <li class="tsd-kind-property tsd-parent-kind-class"><a href="_docker_.docker.html#node" class="tsd-kind-icon">node</a></li> |
| <li class="tsd-kind-property tsd-parent-kind-class"><a href="_docker_.docker.html#plugin" class="tsd-kind-icon">plugin</a></li> |
| <li class="tsd-kind-property tsd-parent-kind-class"><a href="_docker_.docker.html#secret" class="tsd-kind-icon">secret</a></li> |
| <li class="tsd-kind-property tsd-parent-kind-class"><a href="_docker_.docker.html#service" class="tsd-kind-icon">service</a></li> |
| <li class="tsd-kind-property tsd-parent-kind-class"><a href="_docker_.docker.html#swarm" class="tsd-kind-icon">swarm</a></li> |
| <li class="tsd-kind-property tsd-parent-kind-class"><a href="_docker_.docker.html#task" class="tsd-kind-icon">task</a></li> |
| <li class="tsd-kind-property tsd-parent-kind-class"><a href="_docker_.docker.html#volume" class="tsd-kind-icon">volume</a></li> |
| </ul> |
| </section> |
| <section class="tsd-index-section "> |
| <h3>Methods</h3> |
| <ul class="tsd-index-list"> |
| <li class="tsd-kind-method tsd-parent-kind-class"><a href="_docker_.docker.html#auth" class="tsd-kind-icon">auth</a></li> |
| <li class="tsd-kind-method tsd-parent-kind-class"><a href="_docker_.docker.html#events" class="tsd-kind-icon">events</a></li> |
| <li class="tsd-kind-method tsd-parent-kind-class"><a href="_docker_.docker.html#info" class="tsd-kind-icon">info</a></li> |
| <li class="tsd-kind-method tsd-parent-kind-class"><a href="_docker_.docker.html#ping" class="tsd-kind-icon">ping</a></li> |
| <li class="tsd-kind-method tsd-parent-kind-class"><a href="_docker_.docker.html#version" class="tsd-kind-icon">version</a></li> |
| </ul> |
| </section> |
| </div> |
| </section> |
| </section> |
| <section class="tsd-panel-group tsd-member-group "> |
| <h2>Constructors</h2> |
| <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> |
| <a name="constructor" class="tsd-anchor"></a> |
| <h3>constructor</h3> |
| <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> |
| <li class="tsd-signature tsd-kind-icon">new <wbr>Docker<span class="tsd-signature-symbol">(</span>opts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_docker_.docker.html" class="tsd-signature-type">Docker</a></li> |
| </ul> |
| <ul class="tsd-descriptions"> |
| <li class="tsd-description"> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/docker.ts#L29">docker.ts:29</a></li> |
| </ul> |
| </aside> |
| <div class="tsd-comment tsd-typography"> |
| <div class="lead"> |
| <p>Creates the Docker object</p> |
| </div> |
| </div> |
| <h4 class="tsd-parameters-title">Parameters</h4> |
| <ul class="tsd-parameters"> |
| <li> |
| <h5>opts: <span class="tsd-signature-type">any</span></h5> |
| <div class="tsd-comment tsd-typography"> |
| <div class="lead"> |
| <p>Docker options</p> |
| </div> |
| </div> |
| </li> |
| </ul> |
| <h4 class="tsd-returns-title">Returns <a href="_docker_.docker.html" class="tsd-signature-type">Docker</a></h4> |
| </li> |
| </ul> |
| </section> |
| </section> |
| <section class="tsd-panel-group tsd-member-group "> |
| <h2>Properties</h2> |
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> |
| <a name="container" class="tsd-anchor"></a> |
| <h3>container</h3> |
| <div class="tsd-signature tsd-kind-icon">container<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ContainerManager</span></div> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/docker.ts#L20">docker.ts:20</a></li> |
| </ul> |
| </aside> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> |
| <a name="image" class="tsd-anchor"></a> |
| <h3>image</h3> |
| <div class="tsd-signature tsd-kind-icon">image<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ImageManager</span></div> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/docker.ts#L21">docker.ts:21</a></li> |
| </ul> |
| </aside> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> |
| <a name="modem" class="tsd-anchor"></a> |
| <h3>modem</h3> |
| <div class="tsd-signature tsd-kind-icon">modem<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Modem</span></div> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/docker.ts#L19">docker.ts:19</a></li> |
| </ul> |
| </aside> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> |
| <a name="network" class="tsd-anchor"></a> |
| <h3>network</h3> |
| <div class="tsd-signature tsd-kind-icon">network<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">NetworkManager</span></div> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/docker.ts#L23">docker.ts:23</a></li> |
| </ul> |
| </aside> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> |
| <a name="node" class="tsd-anchor"></a> |
| <h3>node</h3> |
| <div class="tsd-signature tsd-kind-icon">node<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">NodeManager</span></div> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/docker.ts#L24">docker.ts:24</a></li> |
| </ul> |
| </aside> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> |
| <a name="plugin" class="tsd-anchor"></a> |
| <h3>plugin</h3> |
| <div class="tsd-signature tsd-kind-icon">plugin<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PluginManager</span></div> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/docker.ts#L25">docker.ts:25</a></li> |
| </ul> |
| </aside> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> |
| <a name="secret" class="tsd-anchor"></a> |
| <h3>secret</h3> |
| <div class="tsd-signature tsd-kind-icon">secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SecretManager</span></div> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/docker.ts#L26">docker.ts:26</a></li> |
| </ul> |
| </aside> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> |
| <a name="service" class="tsd-anchor"></a> |
| <h3>service</h3> |
| <div class="tsd-signature tsd-kind-icon">service<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ServiceManager</span></div> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/docker.ts#L27">docker.ts:27</a></li> |
| </ul> |
| </aside> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> |
| <a name="swarm" class="tsd-anchor"></a> |
| <h3>swarm</h3> |
| <div class="tsd-signature tsd-kind-icon">swarm<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SwarmManager</span></div> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/docker.ts#L28">docker.ts:28</a></li> |
| </ul> |
| </aside> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> |
| <a name="task" class="tsd-anchor"></a> |
| <h3>task</h3> |
| <div class="tsd-signature tsd-kind-icon">task<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TaskManager</span></div> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/docker.ts#L29">docker.ts:29</a></li> |
| </ul> |
| </aside> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> |
| <a name="volume" class="tsd-anchor"></a> |
| <h3>volume</h3> |
| <div class="tsd-signature tsd-kind-icon">volume<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">VolumeManager</span></div> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/docker.ts#L22">docker.ts:22</a></li> |
| </ul> |
| </aside> |
| </section> |
| </section> |
| <section class="tsd-panel-group tsd-member-group "> |
| <h2>Methods</h2> |
| <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> |
| <a name="auth" class="tsd-anchor"></a> |
| <h3>auth</h3> |
| <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> |
| <li class="tsd-signature tsd-kind-icon">auth<span class="tsd-signature-symbol">(</span>opts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> |
| </ul> |
| <ul class="tsd-descriptions"> |
| <li class="tsd-description"> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/docker.ts#L57">docker.ts:57</a></li> |
| </ul> |
| </aside> |
| <div class="tsd-comment tsd-typography"> |
| <div class="lead"> |
| <p>Validate credentials for a registry and get identity token, |
| if available, for accessing the registry without password |
| <a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/check-auth-configuration">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/check-auth-configuration</a></p> |
| </div> |
| </div> |
| <h4 class="tsd-parameters-title">Parameters</h4> |
| <ul class="tsd-parameters"> |
| <li> |
| <h5>opts: <span class="tsd-signature-type">Object</span></h5> |
| <div class="tsd-comment tsd-typography"> |
| <p>Auth options</p> |
| </div> |
| </li> |
| </ul> |
| <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> |
| <p>Promise returning the result</p> |
| </li> |
| </ul> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> |
| <a name="events" class="tsd-anchor"></a> |
| <h3>events</h3> |
| <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> |
| <li class="tsd-signature tsd-kind-icon">events<span class="tsd-signature-symbol">(</span>opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> |
| </ul> |
| <ul class="tsd-descriptions"> |
| <li class="tsd-description"> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/docker.ts#L152">docker.ts:152</a></li> |
| </ul> |
| </aside> |
| <div class="tsd-comment tsd-typography"> |
| <div class="lead"> |
| <p>Get container events from docker, can be in real time via streaming or via polling (with since) |
| <a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/monitor-docker-s-events">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/monitor-docker-s-events</a></p> |
| </div> |
| </div> |
| <h4 class="tsd-parameters-title">Parameters</h4> |
| <ul class="tsd-parameters"> |
| <li> |
| <h5><span class="tsd-flag ts-flagDefault value">Default value</span> opts: <span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol"> = {}</span></h5> |
| <div class="tsd-comment tsd-typography"> |
| <p>Options to send with the request (optional)</p> |
| </div> |
| </li> |
| </ul> |
| <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> |
| <p>Promise returning the result</p> |
| </li> |
| </ul> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> |
| <a name="info" class="tsd-anchor"></a> |
| <h3>info</h3> |
| <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> |
| <li class="tsd-signature tsd-kind-icon">info<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> |
| </ul> |
| <ul class="tsd-descriptions"> |
| <li class="tsd-description"> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/docker.ts#L82">docker.ts:82</a></li> |
| </ul> |
| </aside> |
| <div class="tsd-comment tsd-typography"> |
| <div class="lead"> |
| <p>Get system wide information about docker |
| <a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/display-system-wide-information">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/display-system-wide-information</a></p> |
| </div> |
| </div> |
| <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> |
| <p>Promise returning the result</p> |
| </li> |
| </ul> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> |
| <a name="ping" class="tsd-anchor"></a> |
| <h3>ping</h3> |
| <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> |
| <li class="tsd-signature tsd-kind-icon">ping<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">String</span><span class="tsd-signature-symbol">></span></li> |
| </ul> |
| <ul class="tsd-descriptions"> |
| <li class="tsd-description"> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/docker.ts#L128">docker.ts:128</a></li> |
| </ul> |
| </aside> |
| <div class="tsd-comment tsd-typography"> |
| <div class="lead"> |
| <p>Ping the docker server |
| <a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/ping-the-docker-server">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/ping-the-docker-server</a></p> |
| </div> |
| </div> |
| <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">String</span><span class="tsd-signature-symbol">></span></h4> |
| <p>Promise returning the result</p> |
| </li> |
| </ul> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> |
| <a name="version" class="tsd-anchor"></a> |
| <h3>version</h3> |
| <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> |
| <li class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> |
| </ul> |
| <ul class="tsd-descriptions"> |
| <li class="tsd-description"> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/docker.ts#L105">docker.ts:105</a></li> |
| </ul> |
| </aside> |
| <div class="tsd-comment tsd-typography"> |
| <div class="lead"> |
| <p>Get docker version information of server |
| <a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/show-the-docker-version-information">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/show-the-docker-version-information</a></p> |
| </div> |
| </div> |
| <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></h4> |
| <p>Promise returning the result</p> |
| </li> |
| </ul> |
| </section> |
| </section> |
| </div> |
| <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> |
| <nav class="tsd-navigation primary"> |
| <ul> |
| <li class="globals "> |
| <a href="../globals.html"><em>Globals</em></a> |
| </li> |
| <li class=" tsd-kind-external-module"> |
| <a href="../modules/_container_.html">"container"</a> |
| </li> |
| <li class="current tsd-kind-external-module"> |
| <a href="../modules/_docker_.html">"docker"</a> |
| </li> |
| <li class=" tsd-kind-external-module"> |
| <a href="../modules/_image_.html">"image"</a> |
| </li> |
| <li class=" tsd-kind-external-module"> |
| <a href="../modules/_network_.html">"network"</a> |
| </li> |
| <li class=" tsd-kind-external-module"> |
| <a href="../modules/_node_.html">"node"</a> |
| </li> |
| <li class=" tsd-kind-external-module"> |
| <a href="../modules/_plugin_.html">"plugin"</a> |
| </li> |
| <li class=" tsd-kind-external-module"> |
| <a href="../modules/_secret_.html">"secret"</a> |
| </li> |
| <li class=" tsd-kind-external-module"> |
| <a href="../modules/_service_.html">"service"</a> |
| </li> |
| <li class=" tsd-kind-external-module"> |
| <a href="../modules/_swarm_.html">"swarm"</a> |
| </li> |
| <li class=" tsd-kind-external-module"> |
| <a href="../modules/_task_.html">"task"</a> |
| </li> |
| <li class=" tsd-kind-external-module"> |
| <a href="../modules/_volume_.html">"volume"</a> |
| </li> |
| </ul> |
| </nav> |
| <nav class="tsd-navigation secondary menu-sticky"> |
| <ul class="before-current"> |
| </ul> |
| <ul class="current"> |
| <li class="current tsd-kind-class tsd-parent-kind-external-module"> |
| <a href="_docker_.docker.html" class="tsd-kind-icon">Docker</a> |
| <ul> |
| <li class=" tsd-kind-constructor tsd-parent-kind-class"> |
| <a href="_docker_.docker.html#constructor" class="tsd-kind-icon">constructor</a> |
| </li> |
| <li class=" tsd-kind-property tsd-parent-kind-class"> |
| <a href="_docker_.docker.html#container" class="tsd-kind-icon">container</a> |
| </li> |
| <li class=" tsd-kind-property tsd-parent-kind-class"> |
| <a href="_docker_.docker.html#image" class="tsd-kind-icon">image</a> |
| </li> |
| <li class=" tsd-kind-property tsd-parent-kind-class"> |
| <a href="_docker_.docker.html#modem" class="tsd-kind-icon">modem</a> |
| </li> |
| <li class=" tsd-kind-property tsd-parent-kind-class"> |
| <a href="_docker_.docker.html#network" class="tsd-kind-icon">network</a> |
| </li> |
| <li class=" tsd-kind-property tsd-parent-kind-class"> |
| <a href="_docker_.docker.html#node" class="tsd-kind-icon">node</a> |
| </li> |
| <li class=" tsd-kind-property tsd-parent-kind-class"> |
| <a href="_docker_.docker.html#plugin" class="tsd-kind-icon">plugin</a> |
| </li> |
| <li class=" tsd-kind-property tsd-parent-kind-class"> |
| <a href="_docker_.docker.html#secret" class="tsd-kind-icon">secret</a> |
| </li> |
| <li class=" tsd-kind-property tsd-parent-kind-class"> |
| <a href="_docker_.docker.html#service" class="tsd-kind-icon">service</a> |
| </li> |
| <li class=" tsd-kind-property tsd-parent-kind-class"> |
| <a href="_docker_.docker.html#swarm" class="tsd-kind-icon">swarm</a> |
| </li> |
| <li class=" tsd-kind-property tsd-parent-kind-class"> |
| <a href="_docker_.docker.html#task" class="tsd-kind-icon">task</a> |
| </li> |
| <li class=" tsd-kind-property tsd-parent-kind-class"> |
| <a href="_docker_.docker.html#volume" class="tsd-kind-icon">volume</a> |
| </li> |
| <li class=" tsd-kind-method tsd-parent-kind-class"> |
| <a href="_docker_.docker.html#auth" class="tsd-kind-icon">auth</a> |
| </li> |
| <li class=" tsd-kind-method tsd-parent-kind-class"> |
| <a href="_docker_.docker.html#events" class="tsd-kind-icon">events</a> |
| </li> |
| <li class=" tsd-kind-method tsd-parent-kind-class"> |
| <a href="_docker_.docker.html#info" class="tsd-kind-icon">info</a> |
| </li> |
| <li class=" tsd-kind-method tsd-parent-kind-class"> |
| <a href="_docker_.docker.html#ping" class="tsd-kind-icon">ping</a> |
| </li> |
| <li class=" tsd-kind-method tsd-parent-kind-class"> |
| <a href="_docker_.docker.html#version" class="tsd-kind-icon">version</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="after-current"> |
| </ul> |
| </nav> |
| </div> |
| </div> |
| </div> |
| <footer class="with-border-bottom"> |
| <div class="container"> |
| <h2>Legend</h2> |
| <div class="tsd-legend-group"> |
| <ul class="tsd-legend"> |
| <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> |
| <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> |
| <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> |
| <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> |
| <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> |
| <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> |
| <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> |
| </ul> |
| <ul class="tsd-legend"> |
| <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> |
| <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> |
| <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> |
| <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> |
| </ul> |
| <ul class="tsd-legend"> |
| <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> |
| <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> |
| <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> |
| <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> |
| <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> |
| <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> |
| </ul> |
| <ul class="tsd-legend"> |
| <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> |
| <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> |
| <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> |
| <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> |
| <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> |
| <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> |
| <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> |
| </ul> |
| <ul class="tsd-legend"> |
| <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> |
| <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> |
| <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> |
| <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> |
| </ul> |
| <ul class="tsd-legend"> |
| <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> |
| <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> |
| <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> |
| </ul> |
| <ul class="tsd-legend"> |
| <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> |
| <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> |
| <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> |
| </ul> |
| <ul class="tsd-legend"> |
| <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> |
| <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> |
| </ul> |
| </div> |
| </div> |
| </footer> |
| <div class="container tsd-generator"> |
| <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p> |
| </div> |
| <div class="overlay"></div> |
| <script src="../assets/js/main.js"></script> |
| <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> |
| </body> |
| </html> |
