thunder-client
Version:
A JavaScript client for the Thunder API
89 lines (47 loc) • 3.08 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Home - 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="ThunderClient.html">ThunderClient</a><ul class='methods'><li data-type='method'><a href="ThunderClient.html#createUser">createUser</a></li><li data-type='method'><a href="ThunderClient.html#deleteUser">deleteUser</a></li><li data-type='method'><a href="ThunderClient.html#getUser">getUser</a></li><li data-type='method'><a href="ThunderClient.html#resetVerificationStatus">resetVerificationStatus</a></li><li data-type='method'><a href="ThunderClient.html#sendEmail">sendEmail</a></li><li data-type='method'><a href="ThunderClient.html#updateUser">updateUser</a></li><li data-type='method'><a href="ThunderClient.html#verifyUser">verifyUser</a></li></ul></li></ul>
</nav>
<div id="main">
<section class="readme">
<article><h1>thunder-client [JavaScript]</h1><p><a href="https://travis-ci.org/RohanNagar/thunder-client-js"><img src="https://travis-ci.org/RohanNagar/thunder-client-js.svg?branch=master" alt="Build Status"></a>
<a href="https://badge.fury.io/js/thunder-client"><img src="https://badge.fury.io/js/thunder-client.svg" alt="npm version"></a></p>
<p>The official JavaScript client library for the Thunder API.</p>
<p>See the docs <a href="https://rohannagar.github.io/thunder-client-js/">here</a></p>
<h2>Usage</h2><p>First, install the package with NPM:</p>
<pre class="prettyprint source lang-bash"><code>$ npm install thunder-client</code></pre><p>Then, require the package and use it to call API methods:</p>
<pre class="prettyprint source lang-js"><code>const ThunderClient = require('thunder-client');
let thunder = new ThunderClient('http://thunder.sanctionco.com', 'application', 'secret');
thunder.getUser('sample@sanctionco.com', 'secure-password', (err, result) => {
if (err) return console.log(err);
console.log(result);
});</code></pre></article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Oct 05 2018 21:34:55 GMT+0000 (UTC) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>