Add documentation

fe5494e8 · Aaron Tidwell · fe5494e8 · fe5494e8 · fe5494e8 · fe5494e8
Commit fe5494e8 authored Mar 20, 2017 by Aaron Tidwell
44 changed files
--- a/Client.html
+++ b/Client.html
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>Client - 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">
+</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="Client.html">Client</a></li><li><a href="Matches.html">Matches</a><ul class='methods'><li data-type='method'><a href="Matches.html#index">index</a></li><li data-type='method'><a href="Matches.html#show">show</a></li><li data-type='method'><a href="Matches.html#update">update</a></li></ul></li><li><a href="Participants.html">Participants</a><ul class='methods'><li data-type='method'><a href="Participants.html#create">create</a></li><li data-type='method'><a href="Participants.html#destroy">destroy</a></li><li data-type='method'><a href="Participants.html#index">index</a></li><li data-type='method'><a href="Participants.html#randomize">randomize</a></li><li data-type='method'><a href="Participants.html#show">show</a></li><li data-type='method'><a href="Participants.html#update">update</a></li></ul></li><li><a href="Tournaments.html">Tournaments</a><ul class='methods'><li data-type='method'><a href="Tournaments.html#create">create</a></li><li data-type='method'><a href="Tournaments.html#destroy">destroy</a></li><li data-type='method'><a href="Tournaments.html#finalize">finalize</a></li><li data-type='method'><a href="Tournaments.html#index">index</a></li><li data-type='method'><a href="Tournaments.html#reset">reset</a></li><li data-type='method'><a href="Tournaments.html#show">show</a></li><li data-type='method'><a href="Tournaments.html#start">start</a></li><li data-type='method'><a href="Tournaments.html#update">update</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-ErrorHandler.html">ErrorHandler</a><ul class='methods'><li data-type='method'><a href="module-ErrorHandler.html#.handle">handle</a></li></ul></li><li><a href="module-Util.html">Util</a><ul class='methods'><li data-type='method'><a href="module-Util.html#.serializeToQSParams">serializeToQSParams</a></li><li data-type='method'><a href="module-Util.html#~camelToUnderscore">camelToUnderscore</a></li><li data-type='method'><a href="module-Util.html#~convert">convert</a></li><li data-type='method'><a href="module-Util.html#~underscoreToCamel">underscoreToCamel</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#createClientoptions">createClient</a></li></ul>
+</nav>
+
+<div id="main">
+    
+    <h1 class="page-title">Client</h1>
+    
+
+    
+
+
+
+
+<section>
+
+<header>
+    
+        <h2>
+        Client
+        
+            <sup class="variation">options</sup>
+        </h2>
+        
+    
+</header>
+
+<article>
+    <div class="container-overview">
+    
+        
+
+    
+
+    <h4 class="name" id="Client"><span class="type-signature"></span>new Client<span class="signature">(options)</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="api_client.js.html">api/client.js</a>, <a href="api_client.js.html#line6">line 6</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+<div class="description">
+    Constructor function for the Client base responsible for communicating with Challonge API
+  You should never need to call new Client().  Instead, call challonge.createClient() and it will create
+  a new instance and set defaults.
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Example</h5>
+    
+    <pre class="prettyprint"><code>const challonge = require('challonge');
+
+const client = challonge.createClient({
+	apiKey: '***yourAPIKey***'
+});</code></pre>
+
+
+
+
+    <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>options</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">object</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">configuration options for this instance</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    
+    </div>
+
+    
+
+    
+
+    
+
+     
+
+    
+
+    
+
+    
+
+    
+
+    
+</article>
+
+</section>
+
+
+
+
+</div>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Mar 20 2017 01:16:37 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+</footer>
+
+<script>prettyPrint();</script>
+<script src="scripts/linenumber.js"></script>
+</body>
+</html>
\ No newline at end of file
--- a/Matches.html
+++ b/Matches.html
--- a/Matches_.html
+++ b/Matches_.html
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Class: Matches</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: Matches</h1>
+
+    
+
+
+
+
+<section>
+
+<header>
+    
+        <h2>Matches
+            <sup class="variation">options</sup>
+        </h2>
+        
+    
+</header>
+
+<article>
+    <div class="container-overview">
+    
+        
+
+    
+
+    <h4 class="name" id="Matches"><span class="type-signature"></span>new Matches<span class="signature">(options)</span><span class="type-signature"></span></h4>
+
+    
+
+
+
+<div class="description">
+    Constructor function for the class to query Matches endpoints
+  <pre>
+    index	GET	tournaments/:tournament/matches
+    show     GET	tournaments/:tournament/matches/:match_id
+    update	PUT	tournaments/:tournament/matches/:match_id
+  </pre>
+</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>options</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">object</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">configuration options for this instance</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="api_matches.js.html">api/matches.js</a>, <a href="api_matches.js.html#line4">line 4</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    
+    </div>
+
+    
+
+    
+
+    
+
+     
+
+    
+
+    
+
+    
+
+    
+
+    
+</article>
+
+</section>
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-ErrorHandler.html">ErrorHandler</a></li><li><a href="module-Util.html">Util</a></li></ul><h3>Classes</h3><ul><li><a href="Client.html">Client</a></li><li><a href="Matches_.html">Matches</a></li><li><a href="Participants.html">Participants</a></li><li><a href="Tournaments.html">Tournaments</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createClientoptions">createClient</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Mar 20 2017 00:31:48 GMT-0400 (EDT)
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>
\ No newline at end of file
--- a/Participants.html
+++ b/Participants.html
--- a/Tournaments.html
+++ b/Tournaments.html
--- a/api_client.js.html
+++ b/api_client.js.html
--- a/api_error-handler.js.html
+++ b/api_error-handler.js.html
--- a/api_matches.js.html
+++ b/api_matches.js.html
--- a/api_participants.js.html
+++ b/api_participants.js.html
--- a/api_tournaments.js.html
+++ b/api_tournaments.js.html
--- a/challonge.js.html
+++ b/challonge.js.html
--- a/fonts/OpenSans-Bold-webfont.eot
+++ b/fonts/OpenSans-Bold-webfont.eot
--- a/fonts/OpenSans-Bold-webfont.svg
+++ b/fonts/OpenSans-Bold-webfont.svg
--- a/fonts/OpenSans-Bold-webfont.woff
+++ b/fonts/OpenSans-Bold-webfont.woff
--- a/fonts/OpenSans-BoldItalic-webfont.eot
+++ b/fonts/OpenSans-BoldItalic-webfont.eot
--- a/fonts/OpenSans-BoldItalic-webfont.svg
+++ b/fonts/OpenSans-BoldItalic-webfont.svg
--- a/fonts/OpenSans-BoldItalic-webfont.woff
+++ b/fonts/OpenSans-BoldItalic-webfont.woff
--- a/fonts/OpenSans-Italic-webfont.eot
+++ b/fonts/OpenSans-Italic-webfont.eot
--- a/fonts/OpenSans-Italic-webfont.svg
+++ b/fonts/OpenSans-Italic-webfont.svg
--- a/fonts/OpenSans-Italic-webfont.woff
+++ b/fonts/OpenSans-Italic-webfont.woff
--- a/fonts/OpenSans-Light-webfont.eot
+++ b/fonts/OpenSans-Light-webfont.eot
--- a/fonts/OpenSans-Light-webfont.svg
+++ b/fonts/OpenSans-Light-webfont.svg
--- a/fonts/OpenSans-Light-webfont.woff
+++ b/fonts/OpenSans-Light-webfont.woff
--- a/fonts/OpenSans-LightItalic-webfont.eot
+++ b/fonts/OpenSans-LightItalic-webfont.eot
--- a/fonts/OpenSans-LightItalic-webfont.svg
+++ b/fonts/OpenSans-LightItalic-webfont.svg
--- a/fonts/OpenSans-LightItalic-webfont.woff
+++ b/fonts/OpenSans-LightItalic-webfont.woff
--- a/fonts/OpenSans-Regular-webfont.eot
+++ b/fonts/OpenSans-Regular-webfont.eot
--- a/fonts/OpenSans-Regular-webfont.svg
+++ b/fonts/OpenSans-Regular-webfont.svg
--- a/fonts/OpenSans-Regular-webfont.woff
+++ b/fonts/OpenSans-Regular-webfont.woff
--- a/global.html
+++ b/global.html
--- a/index.html
+++ b/index.html
--- a/module-ErrorHandler.html
+++ b/module-ErrorHandler.html
--- a/module-Util.html
+++ b/module-Util.html
--- a/param-serializer.js.html
+++ b/param-serializer.js.html
--- a/scripts/linenumber.js
+++ b/scripts/linenumber.js
--- a/scripts/prettify/Apache-License-2.0.txt
+++ b/scripts/prettify/Apache-License-2.0.txt
--- a/scripts/prettify/lang-css.js
+++ b/scripts/prettify/lang-css.js
--- a/scripts/prettify/prettify.js
+++ b/scripts/prettify/prettify.js
--- a/styles/jsdoc-default.css
+++ b/styles/jsdoc-default.css
--- a/styles/jsdoc.css
+++ b/styles/jsdoc.css
--- a/styles/prettify-jsdoc.css
+++ b/styles/prettify-jsdoc.css
--- a/styles/prettify-tomorrow.css
+++ b/styles/prettify-tomorrow.css
--- a/styles/prettify.css
+++ b/styles/prettify.css
--- a/util.js.html
+++ b/util.js.html