digitalocean
Version:
nodejs wrapper for digitalocean v2 api
986 lines (275 loc) • 13.4 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</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-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Type Definitions</h3>
<h4 class="name" id="ClientOptions">ClientOptions</h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>request</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">pass in a specific version of the request library.</td>
</tr>
<tr>
<td class="name"><code>promise</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">pass in a specific version of promise library.</td>
</tr>
<tr>
<td class="name"><code>requestOptions</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">a base set of options provided to Request, overridden by options passed to a specific API method. defaults to empty object.</td>
</tr>
<tr>
<td class="name"><code>decamelizeKeys</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">whether to automagically translate query and JSON body keys to use underscore separated names.</td>
</tr>
<tr>
<td class="name"><code>protocol</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">defaults to https.</td>
</tr>
<tr>
<td class="name"><code>hostname</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">defaults to api.digitalocean.com.</td>
</tr>
<tr>
<td class="name"><code>port</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">defaults to protocol default (e.g. with a protocol of https defaults to 443).</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_client.js.html">digitalocean/client.js</a>, <a href="digitalocean_client.js.html#line34">line 34</a>
</li></ul></dd>
</dl>
<h4 class="name" id="listRequestCallback"><span class="type-signature"></span>listRequestCallback<span class="signature">(error, listResource, headers, body)</span><span class="type-signature"></span></h4>
<div class="description">
Every resource method accepts an optional callback as the last argument.
</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>error</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">An error or null if no error occurred.</td>
</tr>
<tr>
<td class="name"><code>listResource</code></td>
<td class="type">
<span class="param-type"><a href="ListResponse.html">ListResponse</a></span>
</td>
<td class="description last">The list resource or null if error.</td>
</tr>
<tr>
<td class="name"><code>headers</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">An object containing the response headers.</td>
</tr>
<tr>
<td class="name"><code>body</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The raw response body.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean.js.html">digitalocean.js</a>, <a href="digitalocean.js.html#line20">line 20</a>
</li></ul></dd>
</dl>
<h4 class="name" id="requestCallback"><span class="type-signature"></span>requestCallback<span class="signature">(error, resource, headers, body)</span><span class="type-signature"></span></h4>
<div class="description">
Every resource method accepts an optional callback as the last argument.
</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>error</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">An error or null if no error occurred.</td>
</tr>
<tr>
<td class="name"><code>resource</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The resource or null if error.</td>
</tr>
<tr>
<td class="name"><code>headers</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">An object containing the response headers.</td>
</tr>
<tr>
<td class="name"><code>body</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The raw response body.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean.js.html">digitalocean.js</a>, <a href="digitalocean.js.html#line10">line 10</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Resources">Resources</h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>resource_id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">a resource ID.</td>
</tr>
<tr>
<td class="name"><code>resource_type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">a resource type.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_tag.js.html">digitalocean/tag.js</a>, <a href="digitalocean_tag.js.html#line50">line 50</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Account.html">Account</a></li><li><a href="Action.html">Action</a></li><li><a href="Certificate.html">Certificate</a></li><li><a href="Client.html">Client</a></li><li><a href="Domain.html">Domain</a></li><li><a href="Droplet.html">Droplet</a></li><li><a href="Firewall.html">Firewall</a></li><li><a href="FloatingIp.html">FloatingIp</a></li><li><a href="Image.html">Image</a></li><li><a href="ListResponse.html">ListResponse</a></li><li><a href="LoadBalancer.html">LoadBalancer</a></li><li><a href="Region.html">Region</a></li><li><a href="Size.html">Size</a></li><li><a href="Snapshot.html">Snapshot</a></li><li><a href="Tag.html">Tag</a></li><li><a href="Volume.html">Volume</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>