| <!doctype html> |
| <html class="default no-js"> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <title>default | 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/_network_.html">"network"</a> |
| </li> |
| <li> |
| <a href="_network_.default.html">default</a> |
| </li> |
| </ul> |
| <h1>Class default</h1> |
| </div> |
| </div> |
| </header> |
| <div class="container container-main"> |
| <div class="row"> |
| <div class="col-8 col-content"> |
| <section class="tsd-panel tsd-hierarchy"> |
| <h3>Hierarchy</h3> |
| <ul class="tsd-hierarchy"> |
| <li> |
| <span class="target">default</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="_network_.default.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="_network_.default.html#modem" class="tsd-kind-icon">modem</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="_network_.default.html#create" class="tsd-kind-icon">create</a></li> |
| <li class="tsd-kind-method tsd-parent-kind-class"><a href="_network_.default.html#get" class="tsd-kind-icon">get</a></li> |
| <li class="tsd-kind-method tsd-parent-kind-class"><a href="_network_.default.html#list" class="tsd-kind-icon">list</a></li> |
| <li class="tsd-kind-method tsd-parent-kind-class"><a href="_network_.default.html#prune" class="tsd-kind-icon">prune</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 default<span class="tsd-signature-symbol">(</span>modem<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Modem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_network_.default.html" class="tsd-signature-type">default</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/network.ts#L138">network.ts:138</a></li> |
| </ul> |
| </aside> |
| <h4 class="tsd-parameters-title">Parameters</h4> |
| <ul class="tsd-parameters"> |
| <li> |
| <h5>modem: <span class="tsd-signature-type">Modem</span></h5> |
| </li> |
| </ul> |
| <h4 class="tsd-returns-title">Returns <a href="_network_.default.html" class="tsd-signature-type">default</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="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/network.ts#L138">network.ts:138</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="create" class="tsd-anchor"></a> |
| <h3>create</h3> |
| <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> |
| <li class="tsd-signature tsd-kind-icon">create<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><a href="_network_.network.html" class="tsd-signature-type">Network</a><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/network.ts#L189">network.ts:189</a></li> |
| </ul> |
| </aside> |
| <div class="tsd-comment tsd-typography"> |
| <div class="lead"> |
| <p>Create a network |
| <a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/create-a-network">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/create-a-network</a></p> |
| </div> |
| </div> |
| <h4 class="tsd-parameters-title">Parameters</h4> |
| <ul class="tsd-parameters"> |
| <li> |
| <h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <span class="tsd-signature-type">Object</span></h5> |
| <div class="tsd-comment tsd-typography"> |
| <p>Query params in 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><a href="_network_.network.html" class="tsd-signature-type">Network</a><span class="tsd-signature-symbol">></span></h4> |
| <p>Promise return the new network</p> |
| </li> |
| </ul> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> |
| <a name="get" class="tsd-anchor"></a> |
| <h3>get</h3> |
| <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> |
| <li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">String</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_network_.network.html" class="tsd-signature-type">Network</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/network.ts#L149">network.ts:149</a></li> |
| </ul> |
| </aside> |
| <div class="tsd-comment tsd-typography"> |
| <div class="lead"> |
| <p>Get a Network object</p> |
| </div> |
| </div> |
| <h4 class="tsd-parameters-title">Parameters</h4> |
| <ul class="tsd-parameters"> |
| <li> |
| <h5>id: <span class="tsd-signature-type">String</span></h5> |
| </li> |
| </ul> |
| <h4 class="tsd-returns-title">Returns <a href="_network_.network.html" class="tsd-signature-type">Network</a></h4> |
| </li> |
| </ul> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> |
| <a name="list" class="tsd-anchor"></a> |
| <h3>list</h3> |
| <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> |
| <li class="tsd-signature tsd-kind-icon">list<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">Array</span><span class="tsd-signature-symbol"><</span><a href="_network_.network.html" class="tsd-signature-type">Network</a><span class="tsd-signature-symbol">></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/network.ts#L159">network.ts:159</a></li> |
| </ul> |
| </aside> |
| <div class="tsd-comment tsd-typography"> |
| <div class="lead"> |
| <p>Get the list of networks |
| <a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/list-networks">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/list-networks</a></p> |
| </div> |
| </div> |
| <h4 class="tsd-parameters-title">Parameters</h4> |
| <ul class="tsd-parameters"> |
| <li> |
| <h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <span class="tsd-signature-type">Object</span></h5> |
| <div class="tsd-comment tsd-typography"> |
| <p>Query params in 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">Array</span><span class="tsd-signature-symbol"><</span><a href="_network_.network.html" class="tsd-signature-type">Network</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4> |
| <p>Promise returning the result as a list of networks</p> |
| </li> |
| </ul> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> |
| <a name="prune" class="tsd-anchor"></a> |
| <h3>prune</h3> |
| <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> |
| <li class="tsd-signature tsd-kind-icon">prune<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/network.ts#L217">network.ts:217</a></li> |
| </ul> |
| </aside> |
| <div class="tsd-comment tsd-typography"> |
| <div class="lead"> |
| <p>Prune network |
| <a href="https://docs.docker.com/engine/api/v1.25/#operation/NetworkPrune">https://docs.docker.com/engine/api/v1.25/#operation/NetworkPrune</a></p> |
| </div> |
| </div> |
| <h4 class="tsd-parameters-title">Parameters</h4> |
| <ul class="tsd-parameters"> |
| <li> |
| <h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <span class="tsd-signature-type">Object</span></h5> |
| <div class="tsd-comment tsd-typography"> |
| <p>Query params in 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 container</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=" 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="current 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"> |
| <li class=" tsd-kind-class tsd-parent-kind-external-module"> |
| <a href="_network_.network.html" class="tsd-kind-icon">Network</a> |
| </li> |
| </ul> |
| <ul class="current"> |
| <li class="current tsd-kind-class tsd-parent-kind-external-module"> |
| <a href="_network_.default.html" class="tsd-kind-icon">default</a> |
| <ul> |
| <li class=" tsd-kind-constructor tsd-parent-kind-class"> |
| <a href="_network_.default.html#constructor" class="tsd-kind-icon">constructor</a> |
| </li> |
| <li class=" tsd-kind-property tsd-parent-kind-class"> |
| <a href="_network_.default.html#modem" class="tsd-kind-icon">modem</a> |
| </li> |
| <li class=" tsd-kind-method tsd-parent-kind-class"> |
| <a href="_network_.default.html#create" class="tsd-kind-icon">create</a> |
| </li> |
| <li class=" tsd-kind-method tsd-parent-kind-class"> |
| <a href="_network_.default.html#get" class="tsd-kind-icon">get</a> |
| </li> |
| <li class=" tsd-kind-method tsd-parent-kind-class"> |
| <a href="_network_.default.html#list" class="tsd-kind-icon">list</a> |
| </li> |
| <li class=" tsd-kind-method tsd-parent-kind-class"> |
| <a href="_network_.default.html#prune" class="tsd-kind-icon">prune</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> |
