out/Scholarcheck.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Scholarcheck</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: Scholarcheck</h1>
<section>
<header>
<h2>
Scholarcheck
</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="Scholarcheck"><span class="type-signature"></span>new Scholarcheck<span class="signature">(apiKey)</span><span class="type-signature"></span></h4>
<div class="description">
Constructor for the Scholarcheck module.
</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>apiKey</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">ScholarCheck.io API key</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#line8">line 8</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="_apiCall"><span class="type-signature"></span>_apiCall<span class="signature">(endpoint, callback)</span><span class="type-signature"></span></h4>
<div class="description">
Internal API call method that returns raw data from an endpoint.
</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>endpoint</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The endpoint to use in the request.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="Scholarcheck.html#~apiCallback">Scholarcheck~apiCallback</a></span>
</td>
<td class="description last">A callback to handle the returned data.</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#line19">line 19</a>
</li></ul></dd>
</dl>
<h4 class="name" id="institution"><span class="type-signature"></span>institution<span class="signature">(email, cb)</span><span class="type-signature"></span></h4>
<div class="description">
Returns the institution name in the callback if the email is a valid institutional email.
</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>email</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">An email to test for validity</td>
</tr>
<tr>
<td class="name"><code>cb</code></td>
<td class="type">
<span class="param-type"><a href="Scholarcheck.html#~institutionCallback">Scholarcheck~institutionCallback</a></span>
</td>
<td class="description last">Calback that returns institution.</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#line65">line 65</a>
</li></ul></dd>
</dl>
<h4 class="name" id="rawData"><span class="type-signature"></span>rawData<span class="signature">(email, cb)</span><span class="type-signature"></span></h4>
<div class="description">
Returns the raw data from the email endpoint.
</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>email</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">An email to test for validity</td>
</tr>
<tr>
<td class="name"><code>cb</code></td>
<td class="type">
<span class="param-type"><a href="Scholarcheck.html#~rawCallback">Scholarcheck~rawCallback</a></span>
</td>
<td class="description last">Calback that returns the raw data.</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#line88">line 88</a>
</li></ul></dd>
</dl>
<h4 class="name" id="valid"><span class="type-signature"></span>valid<span class="signature">(email, cb)</span><span class="type-signature"></span></h4>
<div class="description">
Returns true in the callback if the email is a valid institutional email.
</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>email</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">An email to test for validity</td>
</tr>
<tr>
<td class="name"><code>cb</code></td>
<td class="type">
<span class="param-type"><a href="Scholarcheck.html#~validCallback">Scholarcheck~validCallback</a></span>
</td>
<td class="description last">Calback that returns validity.</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#line43">line 43</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<h4 class="name" id="~apiCallback"><span class="type-signature"></span>apiCallback<span class="signature">(err, data)</span><span class="type-signature"></span></h4>
<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>err</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Any error that occured. Otherwise null.</td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Raw API data returned.</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#line31">line 31</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~institutionCallback"><span class="type-signature"></span>institutionCallback<span class="signature">(err, institution)</span><span class="type-signature"></span></h4>
<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>err</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Any error that occured. Otherwise null.</td>
</tr>
<tr>
<td class="name"><code>institution</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">True if email is institutional, otherwise false.</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#line76">line 76</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~rawCallback"><span class="type-signature"></span>rawCallback<span class="signature">(err, data)</span><span class="type-signature"></span></h4>
<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>err</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Any error that occured. Otherwise null.</td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Raw API data returned.</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#line98">line 98</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~validCallback"><span class="type-signature"></span>validCallback<span class="signature">(err, valid)</span><span class="type-signature"></span></h4>
<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>err</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Any error that occured. Otherwise null.</td>
</tr>
<tr>
<td class="name"><code>valid</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">True if email is institutional, otherwise false.</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#line53">line 53</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Scholarcheck.html">Scholarcheck</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta3</a> on Sat May 02 2015 17:29:25 GMT-0700 (Pacific Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>