docs/HttpTransportClient.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>HttpTransportClient - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="HttpTransportClient.html">HttpTransportClient</a><ul class='methods'><li data-type='method'><a href="HttpTransportClient.html#delete">delete</a></li><li data-type='method'><a href="HttpTransportClient.html#get">get</a></li><li data-type='method'><a href="HttpTransportClient.html#head">head</a></li><li data-type='method'><a href="HttpTransportClient.html#post">post</a></li><li data-type='method'><a href="HttpTransportClient.html#put">put</a></li></ul></li></ul>
</nav>
<div id="main">
<h1 class="page-title">HttpTransportClient</h1>
<section>
<header>
<h2>
HttpTransportClient
</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="HttpTransportClient"><span class="type-signature"></span>new HttpTransportClient<span class="signature">(params)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="client.js.html">client.js</a>, <a href="client.js.html#line13">line 13</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li>ClientParams</li>
</ul>
</dd>
</dl>
<div class="description">
<p>HttpTransport rest client implementation</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>params</code></td>
<td class="type">
<span class="param-type">ClientParams</span>
</td>
<td class="description last"><p>Client parameters</p></td>
</tr>
</tbody>
</table>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="delete"><span class="type-signature">(async) </span>delete<span class="signature">(uri, opts)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="client.js.html">client.js</a>, <a href="client.js.html#line101">line 101</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Executes a HTTP DELETE</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>uri</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>uri to request</p></td>
</tr>
<tr>
<td class="name"><code>opts</code></td>
<td class="type">
<span class="param-type">RequestOptions</span>
</td>
<td class="description last"><p>optional request configuration</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>a Promise<Response> instance</p>
</div>
<h4 class="name" id="get"><span class="type-signature">(async) </span>get<span class="signature">(uri, opts)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="client.js.html">client.js</a>, <a href="client.js.html#line33">line 33</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Executes a HTTP GET</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>uri</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>uri to request</p></td>
</tr>
<tr>
<td class="name"><code>opts</code></td>
<td class="type">
<span class="param-type">RequestOptions</span>
</td>
<td class="description last"><p>optional request configuration</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>a Promise<Response> instance</p>
</div>
<h4 class="name" id="head"><span class="type-signature">(async) </span>head<span class="signature">(uri, opts)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="client.js.html">client.js</a>, <a href="client.js.html#line86">line 86</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Executes a HTTP HEAD</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>uri</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>uri to request</p></td>
</tr>
<tr>
<td class="name"><code>opts</code></td>
<td class="type">
<span class="param-type">RequestOptions</span>
</td>
<td class="description last"><p>optional request configuration</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>a Promise<Response> instance</p>
</div>
<h4 class="name" id="post"><span class="type-signature">(async) </span>post<span class="signature">(uri, body, opts)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="client.js.html">client.js</a>, <a href="client.js.html#line50">line 50</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Executes a HTTP POST</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>uri</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>uri to request</p></td>
</tr>
<tr>
<td class="name"><code>body</code></td>
<td class="type">
<span class="param-type">RequestBody</span>
</td>
<td class="description last"><p>request body</p></td>
</tr>
<tr>
<td class="name"><code>opts</code></td>
<td class="type">
<span class="param-type">RequestOptions</span>
</td>
<td class="description last"><p>optional request configuration</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>a Promise<Response> instance</p>
</div>
<h4 class="name" id="put"><span class="type-signature">(async) </span>put<span class="signature">(uri, body, opts)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="client.js.html">client.js</a>, <a href="client.js.html#line66">line 66</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Executes a HTTP PUT</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>uri</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>uri to request</p></td>
</tr>
<tr>
<td class="name"><code>body</code></td>
<td class="type">
<span class="param-type">RequestBody</span>
</td>
<td class="description last"><p>request body</p></td>
</tr>
<tr>
<td class="name"><code>opts</code></td>
<td class="type">
<span class="param-type">RequestOptions</span>
</td>
<td class="description last"><p>optional request configuration</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>a Promise<Response> instance</p>
</div>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed May 01 2019 13:32:59 GMT+0100 (British Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>