node-docker-api
Version:
Docker Remote API driver for node
809 lines • 65.5 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Container | 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/_container_.html">"container"</a>
</li>
<li>
<a href="_container_.container.html">Container</a>
</li>
</ul>
<h1>Class Container</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>Class representing a container</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Container</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="_container_.container.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="_container_.container.html#warnings" class="tsd-kind-icon">Warnings</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_container_.container.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_container_.container.html#exec" class="tsd-kind-icon">exec</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_container_.container.html#fs" class="tsd-kind-icon">fs</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_container_.container.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_container_.container.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="_container_.container.html#attach" class="tsd-kind-icon">attach</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_container_.container.html#changes" class="tsd-kind-icon">changes</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_container_.container.html#commit" class="tsd-kind-icon">commit</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_container_.container.html#delete" class="tsd-kind-icon">delete</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_container_.container.html#export" class="tsd-kind-icon">export</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_container_.container.html#kill" class="tsd-kind-icon">kill</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_container_.container.html#logs" class="tsd-kind-icon">logs</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_container_.container.html#pause" class="tsd-kind-icon">pause</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_container_.container.html#rename" class="tsd-kind-icon">rename</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_container_.container.html#resize" class="tsd-kind-icon">resize</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_container_.container.html#restart" class="tsd-kind-icon">restart</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_container_.container.html#start" class="tsd-kind-icon">start</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_container_.container.html#stats" class="tsd-kind-icon">stats</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_container_.container.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_container_.container.html#stop" class="tsd-kind-icon">stop</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_container_.container.html#top" class="tsd-kind-icon">top</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_container_.container.html#unpause" class="tsd-kind-icon">unpause</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_container_.container.html#update" class="tsd-kind-icon">update</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_container_.container.html#wait" class="tsd-kind-icon">wait</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_container_.container.html#wsattach" class="tsd-kind-icon">wsattach</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>Container<span class="tsd-signature-symbol">(</span>modem<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Modem</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="_container_.container.html" class="tsd-signature-type">Container</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/container.ts#L315">container.ts:315</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create an container object</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>modem: <span class="tsd-signature-type">Modem</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Modem to connect to the remote service</p>
</div>
</div>
</li>
<li>
<h5>id: <span class="tsd-signature-type">String</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Container id</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_container_.container.html" class="tsd-signature-type">Container</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="warnings" class="tsd-anchor"></a>
<h3>Warnings</h3>
<div class="tsd-signature tsd-kind-icon">Warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/container.ts#L314">container.ts:314</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="data" class="tsd-anchor"></a>
<h3>data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/container.ts#L315">container.ts:315</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="exec" class="tsd-anchor"></a>
<h3>exec</h3>
<div class="tsd-signature tsd-kind-icon">exec<span class="tsd-signature-symbol">:</span> <a href="_container_.execmanager.html" class="tsd-signature-type">ExecManager</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/container.ts#L313">container.ts:313</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="fs" class="tsd-anchor"></a>
<h3>fs</h3>
<div class="tsd-signature tsd-kind-icon">fs<span class="tsd-signature-symbol">:</span> <a href="_container_.containerfs.html" class="tsd-signature-type">ContainerFs</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/container.ts#L312">container.ts:312</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="id" class="tsd-anchor"></a>
<h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">String</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AgustinCB/docker-api/blob/97b290e/src/container.ts#L311">container.ts:311</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/container.ts#L310">container.ts:310</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="attach" class="tsd-anchor"></a>
<h3>attach</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">attach<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><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><span class="tsd-signature-type">Object</span><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/container.ts#L745">container.ts:745</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Attach to a container.
<a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/attach-to-a-container">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/attach-to-a-container</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">any</span><span class="tsd-signature-symbol"> = {}</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><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
<p>Promise returning the container</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="changes" class="tsd-anchor"></a>
<h3>changes</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">changes<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">Array</span><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></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/container.ts#L417">container.ts:417</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get changes on a container's filesystem
<a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/inspect-changes-on-a-container-s-filesystem">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/inspect-changes-on-a-container-s-filesystem</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">Array</span><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></h4>
<p>Promise returning the changes</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="commit" class="tsd-anchor"></a>
<h3>commit</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">commit<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><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_image_.image.html" class="tsd-signature-type">Image</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/container.ts#L854">container.ts:854</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Commit container into an image
<a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/create-a-new-image-from-a-container-s-changes">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/create-a-new-image-from-a-container-s-changes</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">any</span><span class="tsd-signature-symbol"> = {}</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="_image_.image.html" class="tsd-signature-type">Image</a><span class="tsd-signature-symbol">></span></h4>
<p>Promise returning the new image</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="delete" class="tsd-anchor"></a>
<h3>delete</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">delete<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">__type</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/container.ts#L827">container.ts:827</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Remove a container.
<a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/remove-a-container">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/remove-a-container</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">__type</span><span class="tsd-signature-symbol">></span></h4>
<p>Promise returning nothing</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="export" class="tsd-anchor"></a>
<h3>export</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">export<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><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/container.ts#L443">container.ts:443</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Export the content of a container
<a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/export-a-container">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/export-a-container</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">any</span><span class="tsd-signature-symbol"> = {}</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 content of the tar file as a stream or as a string</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="kill" class="tsd-anchor"></a>
<h3>kill</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">kill<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="_container_.container.html" class="tsd-signature-type">Container</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/container.ts#L612">container.ts:612</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Kill a container
<a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/kill-a-container">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/kill-a-container</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="_container_.container.html" class="tsd-signature-type">Container</a><span class="tsd-signature-symbol">></span></h4>
<p>Promise returning the container</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="logs" class="tsd-anchor"></a>
<h3>logs</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">logs<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/container.ts#L390">container.ts:390</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get stdout and stderr logs from a container
<a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/get-container-logs">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/get-container-logs</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 concatenated logs</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="pause" class="tsd-anchor"></a>
<h3>pause</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">pause<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><a href="_container_.container.html" class="tsd-signature-type">Container</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/container.ts#L694">container.ts:694</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Pause a container.
<a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/pause-a-container">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/pause-a-container</a></p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_container_.container.html" class="tsd-signature-type">Container</a><span class="tsd-signature-symbol">></span></h4>
<p>Promise returning the container</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="rename" class="tsd-anchor"></a>
<h3>rename</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">rename<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="_container_.container.html" class="tsd-signature-type">Container</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/container.ts#L668">container.ts:668</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Rename a container.
<a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/rename-a-container">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/rename-a-container</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>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="_container_.container.html" class="tsd-signature-type">Container</a><span class="tsd-signature-symbol">></span></h4>
<p>Promise returning the container</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="resize" class="tsd-anchor"></a>
<h3>resize</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">resize<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/container.ts#L506">container.ts:506</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Resize the TTY for a container. You must restart the container to make the resize take effect.
<a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/resize-a-container-tty">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/resize-a-container-tty</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 response</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="restart" class="tsd-anchor"></a>
<h3>restart</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">restart<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="_container_.container.html" class="tsd-signature-type">Container</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/container.ts#L586">container.ts:586</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Restart a container
<a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/restart-a-container">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/restart-a-container</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="_container_.container.html" class="tsd-signature-type">Container</a><span class="tsd-signature-symbol">></span></h4>
<p>Promise returning the container</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="start" class="tsd-anchor"></a>
<h3>start</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">start<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="_container_.container.html" class="tsd-signature-type">Container</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/container.ts#L532">container.ts:532</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Start a container
<a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/start-a-container">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/start-a-container</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>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="_container_.container.html" class="tsd-signature-type">Container</a><span class="tsd-signature-symbol">></span></h4>
<p>Promise returning the container</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="stats" class="tsd-anchor"></a>
<h3>stats</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">stats<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/container.ts#L479">container.ts:479</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the stats of a container, either by a live stream or the current state
<a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/export-a-container">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/export-a-container</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 stats, in a stream or string</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="status" class="tsd-anchor"></a>
<h3>status</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">status<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="_container_.container.html" class="tsd-signature-type">Container</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/container.ts#L336">container.ts:336</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get low-level information on a container
<a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/inspect-a-container">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/inspect-a-container</a>
The reason why this module isn't called inspect is because that interferes with the inspect utility of node.</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="_container_.container.html" class="tsd-signature-type">Container</a><span class="tsd-signature-symbol">></span></h4>
<p>Promise return the container</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="stop" class="tsd-anchor"></a>
<h3>stop</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">stop<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="_container_.container.html" class="tsd-signature-type">Container</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/container.ts#L559">container.ts:559</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Stop a container
<a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/stop-a-container">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/stop-a-container</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="_container_.container.html" class="tsd-signature-type">Container</a><span class="tsd-signature-symbol">></span></h4>
<p>Promise returning the container</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="top" class="tsd-anchor"></a>
<h3>top</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">top<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><span class="tsd-signature-type">Object</span><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/container.ts#L364">container.ts:364</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get list of processes (ps) inside a container. Not supported in Windows.
<a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/list-processes-running-inside-a-container">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/list-processes-running-inside-a-container</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><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
<p>Promise return the list of processes</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="unpause" class="tsd-anchor"></a>
<h3>unpause</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">unpause<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><a href="_container_.container.html" class="tsd-signature-type">Container</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/container.ts#L719">container.ts:719</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Unpause a container.
<a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/unpause-a-container">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/unpause-a-container</a></p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_container_.container.html" class="tsd-signature-type">Container</a><span class="tsd-signature-symbol">></span></h4>
<p>Promise returning the container</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="update" class="tsd-anchor"></a>
<h3>update</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">update<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="_container_.container.html" class="tsd-signature-type">Container</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/container.ts#L639">container.ts:639</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Update configuration a container.
Docs says you can do it for more than one, but doesn't exaplin how, so let's leave it in only one
<a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/update-a-container">https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/update-a-container</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="_container_.container.html" class="tsd-signature-type">Container</a><span class="tsd-signa