harrogateclient
Version:
A simple node.js client for Kipr Harrogate on their Wallaby's.
686 lines (182 loc) • 8.18 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: ProjectInfo</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">Class: ProjectInfo</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>ProjectInfo<span class="signature">(include, source, data, addFile)</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="ProjectInfo"><span class="type-signature"></span>new ProjectInfo<span class="signature">(include, source, data, addFile)</span><span class="type-signature"></span></h4>
<div class="description">
Creates a ProjectInfo object.
</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>include</code></td>
<td class="type">
<span class="param-type">Array.<<a href="File.html">File</a>></span>
</td>
<td class="description last">array of include files</td>
</tr>
<tr>
<td class="name"><code>source</code></td>
<td class="type">
<span class="param-type">Array.<<a href="File.html">File</a>></span>
</td>
<td class="description last">array of source files</td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">Array.<<a href="File.html">File</a>></span>
</td>
<td class="description last">array of data files</td>
</tr>
<tr>
<td class="name"><code>addFile</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">function to add a file</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line119">line 119</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="data"><span class="type-signature"></span>data<span class="type-signature"> :Array.<<a href="File.html">File</a>></span></h4>
<div class="description">
Array of data files
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<<a href="File.html">File</a>></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line139">line 139</a>
</li></ul></dd>
</dl>
<h4 class="name" id="include"><span class="type-signature"></span>include<span class="type-signature"> :Array.<<a href="File.html">File</a>></span></h4>
<div class="description">
array of include files
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<<a href="File.html">File</a>></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line127">line 127</a>
</li></ul></dd>
</dl>
<h4 class="name" id="source"><span class="type-signature"></span>source<span class="type-signature"> :Array.<<a href="File.html">File</a>></span></h4>
<div class="description">
Array of source files
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<<a href="File.html">File</a>></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line133">line 133</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="addFile"><span class="type-signature"></span>addFile<span class="signature">(dir, name)</span><span class="type-signature"> → {Promise.<<a href="File.html">File</a>, error>}</span></h4>
<div class="description">
Adds a file to the project.
</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>dir</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">name of the directory</td>
</tr>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">name of the file</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line148">line 148</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="File.html">File</a>, error></span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="File.html">File</a></li><li><a href="HarrogateClient.html">HarrogateClient</a></li><li><a href="Project.html">Project</a></li><li><a href="ProjectInfo.html">ProjectInfo</a></li><li><a href="User.html">User</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Feb 23 2018 14:24:20 GMT+0100 (Mitteleuropäische Zeit)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>