Skip to content

C
Challonge
Commit fde1c051 authored by Aaron Tidwell's avatar Aaron Tidwell
Browse files
Options

Add documentation

parent ff8ec03e
Show whitespace changes
Inline Side-by-side
Showing with 21013 additions and 29 deletions
README.md
View file @ fde1c051
......@@ -9,16 +9,15 @@ $ npm install challonge --save
### Get all tournaments on your account
```js
var challonge = require('challonge');
const challonge = require('challonge');
var client = challonge.createClient({
const client = challonge.createClient({
apiKey: '***yourAPIKey***'
});
client.tournaments.index({
callback: function(err, data){
if (err) { console.log(err); return; }
console.log(data);
callback: (err, data) => {
console.log(err, data);
}
});
......@@ -26,10 +25,10 @@ client.tournaments.index({
### Create a tournament
```js
var challonge = require('challonge');
const challonge = require('challonge');
// create a new instance of the client
var client = challonge.createClient({
const client = challonge.createClient({
apiKey: '***yourAPIKey***',
});
......@@ -40,9 +39,8 @@ client.tournaments.create({
url: 'new_tournament_url',
tournamentType: 'single elimination',
},
callback: function(err, data){
if (err) { console.log(err); return; }
console.log(data);
callback: (err, data) => {
console.log(err, data);
}
});
```
......@@ -70,7 +68,7 @@ For API calls that require nested params (eg: http://api.challonge.com/v1/docume
url: 'new_tournament_url',
tournamentType: 'single elimination',
},
callback: function(err, data){}
callback: (err, data) => {}
}
```
......
docs/Client.html 0 → 100644
View file @ fde1c051
<!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
docs/Matches.html 0 → 100644
View file @ fde1c051
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Matches - 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">Matches</h1>
<section>
<header>
<h2>
Matches
</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>
<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 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>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="index"><span class="type-signature"></span>index<span class="signature">(obj)</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_matches.js.html">api/matches.js</a>, <a href="api_matches.js.html#line41">line 41</a>
</li></ul></dd>
</dl>
<div class="description">
Retrieve a tournament's match list.
See the <a href="http://api.challonge.com/v1/documents/matches/index">Challonge API Doc</a> for a full list of object properties.
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>client.matches.index({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});</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>obj</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">params to pass to the api request
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The url of the tournament to get the matches from</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">A method to call when the API returns. Arguments are (error, data)</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h4 class="name" id="show"><span class="type-signature"></span>show<span class="signature">(obj)</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_matches.js.html">api/matches.js</a>, <a href="api_matches.js.html#line69">line 69</a>
</li></ul></dd>
</dl>
<div class="description">
Retrieve a single match record for a tournament.
See the <a href="http://api.challonge.com/v1/documents/matches/show">Challonge API Doc</a> for a full list of object properties.
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>client.matches.show({
id: 'my-tournament-url',
matchId: '12345678',
callback: (err, data) => {
console.log(err, data);
}
});</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>obj</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">params to pass to the api request
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The url of the tournament to get the match from</td>
</tr>
<tr>
<td class="name"><code>matchId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The id of the match to get</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">A method to call when the API returns. Arguments are (error, data)</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">(obj)</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_matches.js.html">api/matches.js</a>, <a href="api_matches.js.html#line103">line 103</a>
</li></ul></dd>
</dl>
<div class="description">
Update/submit the score(s) for a match.
See the <a href="http://api.challonge.com/v1/documents/matches/update">Challonge API Doc</a> for a full list of object properties.
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>client.matches.update({
id: 'my-tournament-url',
matchId: '12345678',
match: {
scoresCsv: '3-0',
winnerId: '678910'
},
callback: (err, data) => {
console.log(err, data);
}
});</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>obj</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">params to pass to the api request
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The url of the tournament to update the match in</td>
</tr>
<tr>
<td class="name"><code>matchId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The id of the match to update</td>
</tr>
<tr>
<td class="name"><code>match</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The match object with updates. See challonge docs for available properties.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">A method to call when the API returns. Arguments are (error, data)</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</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
docs/Matches_.html 0 → 100644
View file @ fde1c051
<!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
docs/Participants.html 0 → 100644
View file @ fde1c051
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Participants - 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">Participants</h1>
<section>
<header>
<h2>
Participants
</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="Participants"><span class="type-signature"></span>new Participants<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_participants.js.html">api/participants.js</a>, <a href="api_participants.js.html#line4">line 4</a>
</li></ul></dd>
</dl>
<div class="description">
Constructor function for the class to query Participants endpoints
<pre>
index GET tournaments/:tournament/participants
create POST tournaments/:tournament/participants
show GET tournaments/:tournament/participants/:participant_id
update PUT tournaments/:tournament/participants/:participant_id
destroy DELETE tournaments/:tournament/participants/:participant_id
randomize GET tournaments/:tournament/participants/randomize
</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>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">(obj)</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_participants.js.html">api/participants.js</a>, <a href="api_participants.js.html#line75">line 75</a>
</li></ul></dd>
</dl>
<div class="description">
Add a participant to a tournament (up until it is started).
See the <a href="http://api.challonge.com/v1/documents/participants/create">Challonge API Doc</a> for a full list of object properties.
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>client.participants.create({
id: 'my-tournament-url',
participant: {
name: 'Bob the Awesome'
},
callback: (err, data) => {
console.log(err, data);
}
});</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>obj</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">params to pass to the api request
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The url of the tournament to create the participants in</td>
</tr>
<tr>
<td class="name"><code>participant</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The participant to create. See challonge docs for available properties.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">A method to call when the API returns. Arguments are (error, data)</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span class="signature">(obj)</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_participants.js.html">api/participants.js</a>, <a href="api_participants.js.html#line165">line 165</a>
</li></ul></dd>
</dl>
<div class="description">
If the tournament has not started, delete a participant, automatically filling in the abandoned seed number. If tournament is underway, mark a participant inactive, automatically forfeiting his/her remaining matches.
See the <a href="http://api.challonge.com/v1/documents/participants/destroy">Challonge API Doc</a> for a full list of object properties.
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>client.participants.destroy({
id: 'my-tournament-url',
participantId: '123456',
callback: (err, data) => {
console.log(err, data);
}
});</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>obj</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">params to pass to the api request
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The url of the tournament to remove a participant from</td>
</tr>
<tr>
<td class="name"><code>participantId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The id of the participant to remove</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">A method to call when the API returns. Arguments are (error, data)</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h4 class="name" id="index"><span class="type-signature"></span>index<span class="signature">(obj)</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_participants.js.html">api/participants.js</a>, <a href="api_participants.js.html#line45">line 45</a>
</li></ul></dd>
</dl>
<div class="description">
Retrieve a tournament's participant list.
See the <a href="http://api.challonge.com/v1/documents/participants/index">Challonge API Doc</a> for a full list of object properties.
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>client.participants.index({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});</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>obj</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">params to pass to the api request
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The url of the tournament to get the participants from</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">A method to call when the API returns. Arguments are (error, data)</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h4 class="name" id="randomize"><span class="type-signature"></span>randomize<span class="signature">(obj)</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_participants.js.html">api/participants.js</a>, <a href="api_participants.js.html#line192">line 192</a>
</li></ul></dd>
</dl>
<div class="description">
Randomize seeds among participants. Only applicable before a tournament has started.
See the <a href="http://api.challonge.com/v1/documents/participants/randomize">Challonge API Doc</a> for a full list of object properties.
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>client.participants.randomize({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});</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>obj</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">params to pass to the api request
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The url of the tournament to randomize the participant seeds in</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">A method to call when the API returns. Arguments are (error, data)</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h4 class="name" id="show"><span class="type-signature"></span>show<span class="signature">(obj)</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_participants.js.html">api/participants.js</a>, <a href="api_participants.js.html#line103">line 103</a>
</li></ul></dd>
</dl>
<div class="description">
Retrieve a single participant record for a tournament.
See the <a href="http://api.challonge.com/v1/documents/participants/show">Challonge API Doc</a> for a full list of object properties.
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>client.participants.show({
id: 'my-tournament-url',
participantId: '123456',
callback: (err, data) => {
console.log(err, data);
}
});</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>obj</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">params to pass to the api request
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The url of the tournament to get a participant in</td>
</tr>
<tr>
<td class="name"><code>participantId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The id of the participant to get</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">A method to call when the API returns. Arguments are (error, data)</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">(obj)</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_participants.js.html">api/participants.js</a>, <a href="api_participants.js.html#line136">line 136</a>
</li></ul></dd>
</dl>
<div class="description">
Update the attributes of a tournament participant.
See the <a href="http://api.challonge.com/v1/documents/participants/update">Challonge API Doc</a> for a full list of object properties.
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>client.participants.update({
id: 'my-tournament-url',
participantId: '123456',
participant: {
name: 'Bob the Super Awesome'
},
callback: (err, data) => {
console.log(err, data);
}
});</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>obj</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">params to pass to the api request
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The url of the tournament to update a participant in</td>
</tr>
<tr>
<td class="name"><code>participantId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The id of the participant to update</td>
</tr>
<tr>
<td class="name"><code>participant</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The participant object with updates. See challonge docs for available properties.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">A method to call when the API returns. Arguments are (error, data)</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</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
docs/Tournaments.html 0 → 100644
View file @ fde1c051
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Tournaments - 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">Tournaments</h1>
<section>
<header>
<h2>
Tournaments
</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="Tournaments"><span class="type-signature"></span>new Tournaments<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_tournaments.js.html">api/tournaments.js</a>, <a href="api_tournaments.js.html#line4">line 4</a>
</li></ul></dd>
</dl>
<div class="description">
Constructor function for the class to query Tournaments endpoints
<pre>
index GET tournaments
create POST tournaments
show GET tournaments/:tournament
update PUT tournaments/:tournament
destroy DELETE tournaments/:tournament
start POST tournaments/:tournament/start
finalize POST tournaments/:tournament/finalize
reset POST tournaments/:tournament/reset
</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>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">(obj)</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_tournaments.js.html">api/tournaments.js</a>, <a href="api_tournaments.js.html#line82">line 82</a>
</li></ul></dd>
</dl>
<div class="description">
Create a new tournament.
See the <a href="http://api.challonge.com/v1/documents/tournaments/create">Challonge API Doc</a> for a full list of object properties.
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>client.tournaments.create({
tournament: {
name: 'My Tournament',
url: 'my-tournament-url',
tournamentType: 'single elimination',
},
callback: (err, data) => {
console.log(err, data);
}
});</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>obj</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">params to pass to the api request
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>tournament</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The tournament to create. See challonge docs for available properties.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">A method to call when the API returns. Arguments are (error, data)</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span class="signature">(obj)</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_tournaments.js.html">api/tournaments.js</a>, <a href="api_tournaments.js.html#line165">line 165</a>
</li></ul></dd>
</dl>
<div class="description">
Deletes a tournament along with all its associated records. There is no undo, so use with care!
See the <a href="http://api.challonge.com/v1/documents/tournaments/destroy">Challonge API Doc</a> for a full list of object properties.
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>client.tournaments.destroy({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});</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>obj</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">params to pass to the api request
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The url of the tournament to remove</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">A method to call when the API returns. Arguments are (error, data)</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h4 class="name" id="finalize"><span class="type-signature"></span>finalize<span class="signature">(obj)</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_tournaments.js.html">api/tournaments.js</a>, <a href="api_tournaments.js.html#line217">line 217</a>
</li></ul></dd>
</dl>
<div class="description">
Finalize a tournament that has had all match scores submitted, rendering its results permanent.
See the <a href="http://api.challonge.com/v1/documents/tournaments/finalize">Challonge API Doc</a> for a full list of object properties.
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>client.tournaments.finalize({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});</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>obj</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">params to pass to the api request
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The url of the tournament to finalize</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">A method to call when the API returns. Arguments are (error, data)</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h4 class="name" id="index"><span class="type-signature"></span>index<span class="signature">(obj)</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_tournaments.js.html">api/tournaments.js</a>, <a href="api_tournaments.js.html#line51">line 51</a>
</li></ul></dd>
</dl>
<div class="description">
Retrieve a set of tournaments created with your account.
See the <a href="http://api.challonge.com/v1/documents/tournaments/index">Challonge API Doc</a> for a full list of object properties.
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>client.tournaments.index({
callback: (err, data) => {
console.log(err, data);
}
});</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>obj</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">params to pass to the api request</td>
</tr>
</tbody>
</table>
<h4 class="name" id="reset"><span class="type-signature"></span>reset<span class="signature">(obj)</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_tournaments.js.html">api/tournaments.js</a>, <a href="api_tournaments.js.html#line243">line 243</a>
</li></ul></dd>
</dl>
<div class="description">
Reset a tournament, clearing all of its scores and attachments. You can then add/remove/edit participants before starting the tournament again.
See the <a href="http://api.challonge.com/v1/documents/tournaments/reset">Challonge API Doc</a> for a full list of object properties.
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>client.tournaments.reset({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});</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>obj</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">params to pass to the api request
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The url of the tournament to reset</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">A method to call when the API returns. Arguments are (error, data)</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h4 class="name" id="show"><span class="type-signature"></span>show<span class="signature">(obj)</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_tournaments.js.html">api/tournaments.js</a>, <a href="api_tournaments.js.html#line109">line 109</a>
</li></ul></dd>
</dl>
<div class="description">
Retrieve a single tournament record created with your account.
See the <a href="http://api.challonge.com/v1/documents/tournaments/show">Challonge API Doc</a> for a full list of object properties.
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>client.tournaments.show({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});</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>obj</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">params to pass to the api request
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The url of the tournament to get</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">A method to call when the API returns. Arguments are (error, data)</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h4 class="name" id="start"><span class="type-signature"></span>start<span class="signature">(obj)</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_tournaments.js.html">api/tournaments.js</a>, <a href="api_tournaments.js.html#line191">line 191</a>
</li></ul></dd>
</dl>
<div class="description">
Start a tournament, opening up first round matches for score reporting. The tournament must have at least 2 participants.
See the <a href="http://api.challonge.com/v1/documents/tournaments/start">Challonge API Doc</a> for a full list of object properties.
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>client.tournaments.start({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});</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>obj</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">params to pass to the api request
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The url of the tournament to start</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">A method to call when the API returns. Arguments are (error, data)</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">(obj)</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_tournaments.js.html">api/tournaments.js</a>, <a href="api_tournaments.js.html#line139">line 139</a>
</li></ul></dd>
</dl>
<div class="description">
Update a tournament's attributes.
See the <a href="http://api.challonge.com/v1/documents/tournaments/update">Challonge API Doc</a> for a full list of object properties.
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>client.tournaments.update({
id: 'my-tournament-url',
tournament: {
name: 'The New Tournament Name'
},
callback: (err, data) => {
console.log(err, data);
}
});</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>obj</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">params to pass to the api request
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The url of the tournament to update</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">A method to call when the API returns. Arguments are (error, data)</td>
</tr>
<tr>
<td class="name"><code>tournament</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The tournament object with updates. See challonge docs for available properties.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</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
docs/api_client.js.html 0 → 100644
View file @ fde1c051
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>api/client.js - 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">api/client.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>const qs = require('querystring');
const https = require('https');
const errorHandler = require('./error-handler');
const util = require('../util');
/**
* @class Client(options)
* @param {object} options configuration options for this instance
* @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.
* @example
const challonge = require('challonge');
const client = challonge.createClient({
apiKey: '***yourAPIKey***'
});
*/
const Client = exports.Client = function(options) {
this.options = options || {};
// defaults - todo convert to an object merge
if (!this.options.version) {
this.options.version = 1;
}
if (typeof this.options.massageProperties === 'undefined') {
this.options.massageProperties = true;
}
if (!this.options.format) {
this.options.format = 'json';
}
this.setSubdomain(this.options.subdomain);
// add a getter to the options passed in - DO NOT mess with instance configs in resources
if (typeof this.options.get !== 'function') {
this.options.get = function(key) { // not an arrow function to maintain "this" reference
return this[key];
};
}
};
Client.prototype.setSubdomain = function(subdomain) {
// generate the subdomain URL string if there is one
if (!subdomain) {
this.options.subdomain = '';
} else if (subdomain[subdomain.length - 1] !== '-') {
this.options.subdomain = subdomain + '-';
} else {
this.options.subdomain = subdomain;
}
};
// cleans the passed in object, generates the API url/query-string, makes the request, delegates errors and calls callbacks
Client.prototype.makeRequest = function(obj) {
const self = this;
const propertiesToDelete = ['callback', 'path', 'method'];
// cache vars that are to be removed
const callback = obj.callback;
const method = obj.method;
let path = obj.path;
// normalize the rest of the properties
obj = util.convert(obj, util.camelToUnderscore);
// Add on the api key
obj.api_key = this.options.get('apiKey');
obj.cache_bust = Math.random();
// remove internal properties
propertiesToDelete.forEach((prop) => {
delete obj[prop];
});
// generate path
const versionPaths = {
1: '/v1/tournaments'
};
const serialized = util.serializeToQSParams(obj);
path = versionPaths[this.options.get('version')] + (path ? path : '') + '.' + this.options.get('format') + '?' + serialized;
// create options for the https call
const options = {
hostname: 'api.challonge.com',
path: path,
method: method,
headers: {
'Content-Length': 0 // server throws nginx error without a content-length
}
};
const req = https.request(options, (res) => {
// store the chunked data as it comes back
let resData = '';
res.on('data', (chunk) => {
resData += chunk;
});
res.on('end', () => {
// error
if (res.statusCode !== 200) {
errorHandler.handle(res, resData, callback, self.options.get('format'));
return;
}
// 200 ok
if (self.options.get('format') == 'json') {
resData = JSON.parse(resData);
if (self.options.get('massageProperties')) {
resData = util.convert(resData, util.underscoreToCamel);
}
}
callback(null, resData); //no error, so no err object
});
});
req.end();
};
</code></pre>
</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>
docs/api_error-handler.js.html 0 → 100644
View file @ fde1c051
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>api/error-handler.js - 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">api/error-handler.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/**
* @module ErrorHandler
* @description
* Internally used to handle errors from the API
*/
/**
* @function
* @methodof ErrorHandler
*
* @param {object} res the http response object
* @param {object} resData the data contained in the response
* @param {Function} callback the users callback function to call
* @param {string} format the format of the response data (json, xml, etc)
* @description
* Handles HTTP response codes issued by the API.
* All other codes are the result of a request not reaching the application.
*/
exports.handle = function(res, resData, callback, format) {
let err;
// 401 - Invalid API key
if (res.statusCode === 401) {
err = {
error: true,
errors: [],
statusCode: res.statusCode,
text: 'Invalid API key'
};
callback(err, res);
return;
}
// 404 - Object not found within your account scope
if (res.statusCode === 404) {
err = {
error: true,
errors: [],
statusCode: res.statusCode,
text: 'Object not found within your account scope'
};
callback(err, res);
return;
}
// 422 - Validation error(s) for create or update method
if (res.statusCode === 422) {
if (format === 'json') {
resData = JSON.parse(resData);
}
err = {
error: true,
errors: resData.errors,
statusCode: res.statusCode,
text: resData
};
callback(err, res);
return;
}
// not an api-documented error
err = {
error: true,
errors: [],
statusCode: res.statusCode,
text: resData
};
// ship the response object back as the data
callback(err, res);
return;
};
</code></pre>
</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>
docs/api_matches.js.html 0 → 100644
View file @ fde1c051
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>api/matches.js - 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">api/matches.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>const util = require('util');
const Client = require('./client').Client;
/**
* @class Matches
* @param {object} options configuration options for this instance
* @description
* Constructor function for the class to query Matches endpoints
* &lt;pre>
* index GET tournaments/:tournament/matches
* show GET tournaments/:tournament/matches/:match_id
* update PUT tournaments/:tournament/matches/:match_id
* &lt;/pre>
*/
const Matches = exports.Matches = function(options) {
Client.call(this, options); // call parent constructor
};
// inherit from Client base object
util.inherits(Matches, Client);
/**
* @function
* @memberof Matches
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to get the matches from
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Retrieve a tournament's match list.
* See the {@link http://api.challonge.com/v1/documents/matches/index|Challonge API Doc} for a full list of object properties.
* @example
client.matches.index({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Matches.prototype.index = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/matches';
delete obj.id;
obj.method = 'GET';
this.makeRequest(obj);
};
/**
* @function
* @memberof Matches
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to get the match from
* @param {string} obj.matchId The id of the match to get
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Retrieve a single match record for a tournament.
* See the {@link http://api.challonge.com/v1/documents/matches/show|Challonge API Doc} for a full list of object properties.
* @example
client.matches.show({
id: 'my-tournament-url',
matchId: '12345678',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Matches.prototype.show = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/matches/' + obj.matchId;
delete obj.id;
delete obj.matchId;
obj.method = 'GET';
this.makeRequest(obj);
};
/**
* @function
* @memberof Matches
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to update the match in
* @param {string} obj.matchId The id of the match to update
* @param {object} obj.match The match object with updates. See challonge docs for available properties.
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Update/submit the score(s) for a match.
* See the {@link http://api.challonge.com/v1/documents/matches/update|Challonge API Doc} for a full list of object properties.
* @example
client.matches.update({
id: 'my-tournament-url',
matchId: '12345678',
match: {
scoresCsv: '3-0',
winnerId: '678910'
},
callback: (err, data) => {
console.log(err, data);
}
});
*/
Matches.prototype.update = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/matches/' + obj.matchId;
delete obj.id;
delete obj.matchId;
obj.method = 'PUT';
this.makeRequest(obj);
};
</code></pre>
</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>
docs/api_participants.js.html 0 → 100644
View file @ fde1c051
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>api/participants.js - 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">api/participants.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>const util = require('util');
const Client = require('./client').Client;
/**
* @class Participants
* @param {object} options configuration options for this instance
* @description
* Constructor function for the class to query Participants endpoints
* &lt;pre>
* index GET tournaments/:tournament/participants
* create POST tournaments/:tournament/participants
* show GET tournaments/:tournament/participants/:participant_id
* update PUT tournaments/:tournament/participants/:participant_id
* destroy DELETE tournaments/:tournament/participants/:participant_id
* randomize GET tournaments/:tournament/participants/randomize
* &lt;/pre>
*/
const Participants = exports.Participants = function(options) {
Client.call(this, options); // call parent constructor
};
// inherit from Client base object
util.inherits(Participants, Client);
/**
* @function
* @memberof Participants
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to get the participants from
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Retrieve a tournament's participant list.
* See the {@link http://api.challonge.com/v1/documents/participants/index|Challonge API Doc} for a full list of object properties.
* @example
client.participants.index({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Participants.prototype.index = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/participants';
delete obj.id;
obj.method = 'GET';
this.makeRequest(obj);
};
/**
* @function
* @memberof Participants
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to create the participants in
* @param {object} obj.participant The participant to create. See challonge docs for available properties.
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Add a participant to a tournament (up until it is started).
* See the {@link http://api.challonge.com/v1/documents/participants/create|Challonge API Doc} for a full list of object properties.
* @example
client.participants.create({
id: 'my-tournament-url',
participant: {
name: 'Bob the Awesome'
},
callback: (err, data) => {
console.log(err, data);
}
});
*/
Participants.prototype.create = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/participants';
delete obj.id;
obj.method = 'POST';
this.makeRequest(obj);
};
/**
* @function
* @memberof Participants
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to get a participant in
* @param {string} obj.participantId The id of the participant to get
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Retrieve a single participant record for a tournament.
* See the {@link http://api.challonge.com/v1/documents/participants/show|Challonge API Doc} for a full list of object properties.
* @example
client.participants.show({
id: 'my-tournament-url',
participantId: '123456',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Participants.prototype.show = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/participants/' + obj.participantId;
delete obj.id;
delete obj.participantId;
obj.method = 'GET';
this.makeRequest(obj);
};
/**
* @function
* @memberof Participants
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to update a participant in
* @param {string} obj.participantId The id of the participant to update
* @param {object} obj.participant The participant object with updates. See challonge docs for available properties.
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Update the attributes of a tournament participant.
* See the {@link http://api.challonge.com/v1/documents/participants/update|Challonge API Doc} for a full list of object properties.
* @example
client.participants.update({
id: 'my-tournament-url',
participantId: '123456',
participant: {
name: 'Bob the Super Awesome'
},
callback: (err, data) => {
console.log(err, data);
}
});
*/
Participants.prototype.update = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/participants/' + obj.participantId;
delete obj.id;
delete obj.participantId;
obj.method = 'PUT';
this.makeRequest(obj);
};
/**
* @function
* @memberof Participants
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to remove a participant from
* @param {string} obj.participantId The id of the participant to remove
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* If the tournament has not started, delete a participant, automatically filling in the abandoned seed number. If tournament is underway, mark a participant inactive, automatically forfeiting his/her remaining matches.
* See the {@link http://api.challonge.com/v1/documents/participants/destroy|Challonge API Doc} for a full list of object properties.
* @example
client.participants.destroy({
id: 'my-tournament-url',
participantId: '123456',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Participants.prototype.destroy = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/participants/' + obj.participantId;
delete obj.id;
delete obj.participantId;
obj.method = 'DELETE';
this.makeRequest(obj);
};
/**
* @function
* @memberof Participants
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to randomize the participant seeds in
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Randomize seeds among participants. Only applicable before a tournament has started.
* See the {@link http://api.challonge.com/v1/documents/participants/randomize|Challonge API Doc} for a full list of object properties.
* @example
client.participants.randomize({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Participants.prototype.randomize = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/participants/randomize';
delete obj.id;
obj.method = 'POST';
this.makeRequest(obj);
};
</code></pre>
</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>
docs/api_tournaments.js.html 0 → 100644
View file @ fde1c051
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>api/tournaments.js - 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">api/tournaments.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>const util = require('util');
const Client = require('./client').Client;
/**
* @class Tournaments
* @param {object} options configuration options for this instance
* @description
* Constructor function for the class to query Tournaments endpoints
* &lt;pre>
* index GET tournaments
* create POST tournaments
* show GET tournaments/:tournament
* update PUT tournaments/:tournament
* destroy DELETE tournaments/:tournament
* start POST tournaments/:tournament/start
* finalize POST tournaments/:tournament/finalize
* reset POST tournaments/:tournament/reset
* &lt;/pre>
*/
const Tournaments = exports.Tournaments = function(options) {
Client.call(this, options); // call parent constructor
this.getRawSubdomain = function() {
const subdomain = this.options.get('subdomain');
if (this.options.get('subdomain')[subdomain.length - 1] === '-') {
return subdomain.substr(0, subdomain.length - 1);
}
return subdomain;
};
};
// inherit from Client base object
util.inherits(Tournaments, Client);
/**
* @function
* @memberof Tournaments
* @param {object} obj params to pass to the api request
* @description
* Retrieve a set of tournaments created with your account.
* See the {@link http://api.challonge.com/v1/documents/tournaments/index|Challonge API Doc} for a full list of object properties.
* @example
client.tournaments.index({
callback: (err, data) => {
console.log(err, data);
}
});
*/
Tournaments.prototype.index = function(obj) {
obj.method = 'GET';
if (this.getRawSubdomain()) {
obj.subdomain = this.getRawSubdomain();
}
this.makeRequest(obj);
};
/**
* @function
* @memberof Tournaments
* @param {object} obj params to pass to the api request
* @param {object} obj.tournament The tournament to create. See challonge docs for available properties.
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Create a new tournament.
* See the {@link http://api.challonge.com/v1/documents/tournaments/create|Challonge API Doc} for a full list of object properties.
* @example
client.tournaments.create({
tournament: {
name: 'My Tournament',
url: 'my-tournament-url',
tournamentType: 'single elimination',
},
callback: (err, data) => {
console.log(err, data);
}
});
*/
Tournaments.prototype.create = function(obj) {
if (this.getRawSubdomain()) {
obj.tournament.subdomain = this.getRawSubdomain();
}
obj.method = 'POST';
this.makeRequest(obj);
};
/**
* @function
* @memberof Tournaments
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to get
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Retrieve a single tournament record created with your account.
* See the {@link http://api.challonge.com/v1/documents/tournaments/show|Challonge API Doc} for a full list of object properties.
* @example
client.tournaments.show({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Tournaments.prototype.show = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id;
delete obj.id;
obj.method = 'GET';
this.makeRequest(obj);
};
/**
* @function
* @memberof Tournaments
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to update
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @param {object} obj.tournament The tournament object with updates. See challonge docs for available properties.
* @description
* Update a tournament's attributes.
* See the {@link http://api.challonge.com/v1/documents/tournaments/update|Challonge API Doc} for a full list of object properties.
* @example
client.tournaments.update({
id: 'my-tournament-url',
tournament: {
name: 'The New Tournament Name'
},
callback: (err, data) => {
console.log(err, data);
}
});
*/
Tournaments.prototype.update = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id;
delete obj.id;
obj.method = 'PUT';
this.makeRequest(obj);
};
/**
* @function
* @memberof Tournaments
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to remove
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Deletes a tournament along with all its associated records. There is no undo, so use with care!
* See the {@link http://api.challonge.com/v1/documents/tournaments/destroy|Challonge API Doc} for a full list of object properties.
* @example
client.tournaments.destroy({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Tournaments.prototype.destroy = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id;
delete obj.id;
obj.method = 'DELETE';
this.makeRequest(obj);
};
/**
* @function
* @memberof Tournaments
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to start
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Start a tournament, opening up first round matches for score reporting. The tournament must have at least 2 participants.
* See the {@link http://api.challonge.com/v1/documents/tournaments/start|Challonge API Doc} for a full list of object properties.
* @example
client.tournaments.start({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Tournaments.prototype.start = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/start';
delete obj.id;
obj.method = 'POST';
this.makeRequest(obj);
};
/**
* @function
* @memberof Tournaments
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to finalize
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Finalize a tournament that has had all match scores submitted, rendering its results permanent.
* See the {@link http://api.challonge.com/v1/documents/tournaments/finalize|Challonge API Doc} for a full list of object properties.
* @example
client.tournaments.finalize({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Tournaments.prototype.finalize = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/finalize';
delete obj.id;
obj.method = 'POST';
this.makeRequest(obj);
};
/**
* @function
* @memberof Tournaments
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to reset
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Reset a tournament, clearing all of its scores and attachments. You can then add/remove/edit participants before starting the tournament again.
* See the {@link http://api.challonge.com/v1/documents/tournaments/reset|Challonge API Doc} for a full list of object properties.
* @example
client.tournaments.reset({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Tournaments.prototype.reset = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/reset';
delete obj.id;
obj.method = 'POST';
this.makeRequest(obj);
};
</code></pre>
</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>
docs/challonge.js.html 0 → 100644
View file @ fde1c051
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>challonge.js - 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">challonge.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>const endpoints = ['Client', 'Tournaments', 'Participants', 'Matches'];
endpoints.forEach(endpointName => {
exports[endpointName] = require('./api/' + endpointName.toLowerCase())[endpointName];
});
/**
* @function createClient(options)
* @methodof modules:Client
* @param {object} options configuration options for this instance
* @returns {object} new api client instance
* @description
* Generates a new API client.
*/
exports.createClient = function createClient(options) {
const client = {};
// require each lib in ./api and instantiate a new instance of each object, passing the options we were passed
endpoints.forEach(endpointName => {
// store for the user to reference via instance.resource
client[endpointName.toLowerCase()] = new exports[endpointName](options);
});
client.setSubdomain = subdomain => {
endpoints.forEach(endpointName => {
client[endpointName.toLowerCase()].setSubdomain(subdomain);
});
};
return client;
};
</code></pre>
</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>
docs/fonts/OpenSans-Bold-webfont.svg 0 → 100644
View file @ fde1c051
This source diff could not be displayed because it is too large. You can view the blob instead.
docs/fonts/OpenSans-BoldItalic-webfont.svg 0 → 100644
View file @ fde1c051
This source diff could not be displayed because it is too large. You can view the blob instead.
docs/fonts/OpenSans-Italic-webfont.svg 0 → 100644
View file @ fde1c051
This source diff could not be displayed because it is too large. You can view the blob instead.
docs/fonts/OpenSans-Light-webfont.svg 0 → 100644
View file @ fde1c051
This source diff could not be displayed because it is too large. You can view the blob instead.
docs/fonts/OpenSans-LightItalic-webfont.svg 0 → 100644
View file @ fde1c051
This source diff could not be displayed because it is too large. You can view the blob instead.
docs/fonts/OpenSans-Regular-webfont.svg 0 → 100644
View file @ fde1c051
This source diff could not be displayed because it is too large. You can view the blob instead.
docs/global.html 0 → 100644
View file @ fde1c051
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Global - 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">Global</h1>
<section>
<header>
<h2>
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="createClientoptions"><span class="type-signature"></span>createClient<span class="signature">(options)</span><span class="type-signature"> &rarr; {object}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="challonge.js.html">challonge.js</a>, <a href="challonge.js.html#line7">line 7</a>
</li></ul></dd>
</dl>
<div class="description">
Generates a new API client.
</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>
<h5>Returns:</h5>
<div class="param-desc">
new api client instance
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
</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
docs/index.html 0 → 100644
View file @ fde1c051
<!DOCTYPE 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">
</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">
<section class="readme">
<article><h2>Usage</h2><h3>Install</h3><pre class="prettyprint source lang-bash"><code>$ npm install challonge --save</code></pre><h3>Get all tournaments on your account</h3><pre class="prettyprint source lang-js"><code>const challonge = require('challonge');
const client = challonge.createClient({
apiKey: '***yourAPIKey***'
});
client.tournaments.index({
callback: (err, data) => {
console.log(err, data);
}
});</code></pre><h3>Create a tournament</h3><pre class="prettyprint source lang-js"><code>const challonge = require('challonge');
// create a new instance of the client
const client = challonge.createClient({
apiKey: '***yourAPIKey***',
});
// create a tournament
client.tournaments.create({
tournament: {
name: 'new_tournament_name',
url: 'new_tournament_url',
tournamentType: 'single elimination',
},
callback: (err, data) => {
console.log(err, data);
}
});</code></pre><h2>API Client</h2><p><em>createClient</em> takes one argument for configuration and returns an instance of the api client. The configuration object can contain the following options:</p>
<ul>
<li><p><code>apiKey</code> string (required) - Your challonge API Key</p>
</li>
<li><p><code>subdomain</code> string (optional) - Setting the subdomain automatically passes tournament[subdomain] and prefixes the subdomain to tournament urls. If you don't want to pass a subdomain to the constructor, and want to use an organization (or multiple organizations), you must use client.setSubdomain('subdomain') before making api calls.</p>
</li>
<li><p><code>format</code> string (optional) - The format of the response data. Defaults to 'json'. If set to 'json', will return javascript objects. 'xml' will return the raw text string.</p>
</li>
<li><p><code>massageProperties</code> boolean (optional) - If the response object should be massaged into camelCase properties when using json format. Defaults to true.</p>
</li>
</ul>
<p>The wrapper is organized into resource.method to match the API</p>
<p>For API calls that require nested params (eg: http://api.challonge.com/v1/documents/tournaments/create) properties should be specified as a nested object:</p>
<pre class="prettyprint source lang-js"><code>{
tournament: {
name: 'new_tournament_name',
url: 'new_tournament_url',
tournamentType: 'single elimination',
},
callback: (err, data) => {}
}</code></pre><p>All properties can be specified camelCase instead of using under_scores Both of the following are valid:</p>
<pre class="prettyprint source lang-js"><code>tournament: { tournamentType: 'single elimination' }</code></pre><pre class="prettyprint source lang-js"><code>tournament: { tournament_type: 'single elimination' }</code></pre><h2>Development</h2><h3>Install</h3><pre class="prettyprint source lang-bash"><code> $ git clone https://github.com/Tidwell/node-challonge
$ cd node-challonge
$ npm install</code></pre><h3>Run Tests</h3><p><a href="https://travis-ci.org/Tidwell/node-challonge"><img src="https://travis-ci.org/Tidwell/node-challonge.svg?branch=master" alt="Build Status"></a></p>
<pre class="prettyprint source lang-bash"><code>$ npm test</code></pre><h3>Run JsFmt/JsHint</h3><pre class="prettyprint source lang-bash"><code>$ npm run-script format</code></pre><pre class="prettyprint source lang-bash"><code>$ npm run-script lint</code></pre><h3>All (travis integration tests)</h3><pre class="prettyprint source lang-bash"><code>$ npm run-script integrate</code></pre><h3>Issue Tracking</h3><p>Issues are tracked on github: https://github.com/Tidwell/node-challonge/issues</p>
<p>The <a href="https://www.zenhub.com/">Zenhub Browser Plugin</a> is used to organize issues.</p>
<p>The structure of this api wrapper is ripped off from https://github.com/nodejitsu/nodejitsu-api</p>
<h3>Branching</h3><p><code>master</code> is the active development branch</p>
<p><code>live</code> is the latest published build on npm</p></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
docs/module-ErrorHandler.html 0 → 100644
View file @ fde1c051
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>ErrorHandler - 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">ErrorHandler</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="description">Internally used to handle errors from the API</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_error-handler.js.html">api/error-handler.js</a>, <a href="api_error-handler.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".handle"><span class="type-signature">(static) </span>handle<span class="signature">(res, resData, callback, format)</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_error-handler.js.html">api/error-handler.js</a>, <a href="api_error-handler.js.html#line19">line 19</a>
</li></ul></dd>
</dl>
<div class="description">
Handles HTTP response codes issued by the API.
All other codes are the result of a request not reaching the application.
</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>res</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">the http response object</td>
</tr>
<tr>
<td class="name"><code>resData</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">the data contained in the response</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">the users callback function to call</td>
</tr>
<tr>
<td class="name"><code>format</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">the format of the response data (json, xml, etc)</td>
</tr>
</tbody>
</table>
</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
docs/module-Util.html 0 → 100644
View file @ fde1c051
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Util - 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">Util</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="description">Internal Utility methods</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="util.js.html">util.js</a>, <a href="util.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".serializeToQSParams"><span class="type-signature">(static) </span>serializeToQSParams<span class="signature">(a)</span><span class="type-signature"> &rarr; {string}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="util.js.html">util.js</a>, <a href="util.js.html#line70">line 70</a>
</li></ul></dd>
</dl>
<div class="description">
Ripped from https://github.com/knowledgecode/jquery-param
</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>a</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">a javascript object</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
the jquery-like querystring to send to the api
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="~camelToUnderscore"><span class="type-signature">(inner) </span>camelToUnderscore<span class="signature">(str)</span><span class="type-signature"> &rarr; {string}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="util.js.html">util.js</a>, <a href="util.js.html#line14">line 14</a>
</li></ul></dd>
</dl>
<div class="description">
Converts a string from camelCase to underscore_case
</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>str</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">the string to convert</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
the string in under_scores
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="~convert"><span class="type-signature">(inner) </span>convert<span class="signature">(obj, conversionFn, newObject<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {object}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="util.js.html">util.js</a>, <a href="util.js.html#line40">line 40</a>
</li></ul></dd>
</dl>
<div class="description">
Converts a string from underscore_case to camelCase
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>obj</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
</td>
<td class="description last">the object to massage the property names for</td>
</tr>
<tr>
<td class="name"><code>conversionFn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="description last">the function to be called passing the object key</td>
</tr>
<tr>
<td class="name"><code>newObject</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">the new object that is assembled (used in recursive calls)</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
a new object with the properties massaged by conversionFn
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="~underscoreToCamel"><span class="type-signature">(inner) </span>underscoreToCamel<span class="signature">(str)</span><span class="type-signature"> &rarr; {string}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="util.js.html">util.js</a>, <a href="util.js.html#line27">line 27</a>
</li></ul></dd>
</dl>
<div class="description">
Converts a string from underscore_case to camelCase
</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>str</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">the string to convert</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
the string in camelCase
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</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
docs/param-serializer.js.html 0 → 100644
View file @ fde1c051
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>param-serializer.js - 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">param-serializer.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/**
* @function modules:Util#serialize
* @param {object} a a javascript object
* @return {string} the jquery-like querystring to send to the api
* @description
* Ripped from https://github.com/knowledgecode/jquery-param
*/
/* istanbul ignore next */
function serialize(a) {
const s = [];
const rbracket = /\[\]$/;
const isArray = function(obj) {
return Object.prototype.toString.call(obj) === '[object Array]';
};
function add(k, v) {
v = typeof v === 'function' ? v() : v === null ? '' : v === undefined ? '' : v;
s[s.length] = encodeURIComponent(k) + '=' + encodeURIComponent(v);
}
function buildParams(prefix, obj) {
let i;
let len;
let key;
if (prefix) {
if (isArray(obj)) {
for (i = 0, len = obj.length; i &lt; len; i++) {
if (rbracket.test(prefix)) {
add(prefix, obj[i]);
} else {
buildParams(prefix + '[' + (typeof obj[i] === 'object' ? i : '') + ']', obj[i]);
}
}
} else if (obj &amp;&amp; String(obj) === '[object Object]') {
for (key in obj) {
buildParams(prefix + '[' + key + ']', obj[key]);
}
} else {
add(prefix, obj);
}
} else if (isArray(obj)) {
for (i = 0, len = obj.length; i &lt; len; i++) {
add(obj[i].name, obj[i].value);
}
} else {
for (key in obj) {
buildParams(key, obj[key]);
}
}
return s;
}
return decodeURIComponent(buildParams('', a).join('&amp;').replace(/%20/g, '+'));
}
module.exports = serialize;
</code></pre>
</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>
docs/scripts/linenumber.js 0 → 100644
View file @ fde1c051
/*global document */
(function() {
var source = document.getElementsByClassName('prettyprint source linenums');
var i = 0;
var lineNumber = 0;
var lineId;
var lines;
var totalLines;
var anchorHash;
if (source && source[0]) {
anchorHash = document.location.hash.substring(1);
lines = source[0].getElementsByTagName('li');
totalLines = lines.length;
for (; i < totalLines; i++) {
lineNumber++;
lineId = 'line' + lineNumber;
lines[i].id = lineId;
if (lineId === anchorHash) {
lines[i].className += ' selected';
}
}
}
})();
docs/scripts/prettify/Apache-License-2.0.txt 0 → 100644
View file @ fde1c051
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
docs/scripts/prettify/lang-css.js 0 → 100644
View file @ fde1c051
PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n "]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com",
/^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]);
docs/scripts/prettify/prettify.js 0 → 100644
View file @ fde1c051
var q=null;window.PR_SHOULD_USE_CONTINUATION=!0;
(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a=
[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c<i;++c){var j=f[c];if(/\\[bdsw]/i.test(j))a.push(j);else{var j=m(j),d;c+2<i&&"-"===f[c+1]?(d=m(f[c+2]),c+=2):d=j;b.push([j,d]);d<65||j>122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;c<b.length;++c)i=b[c],i[0]<=j[1]+1?j[1]=Math.max(j[1],i[1]):f.push(j=i);b=["["];o&&b.push("^");b.push.apply(b,a);for(c=0;c<
f.length;++c)i=f[c],b.push(e(i[0])),i[1]>i[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c<b;++c){var j=f[c];j==="("?++i:"\\"===j.charAt(0)&&(j=+j.substring(1))&&j<=i&&(d[j]=-1)}for(c=1;c<d.length;++c)-1===d[c]&&(d[c]=++t);for(i=c=0;c<b;++c)j=f[c],j==="("?(++i,d[i]===void 0&&(f[c]="(?:")):"\\"===j.charAt(0)&&
(j=+j.substring(1))&&j<=i&&(f[c]="\\"+d[i]);for(i=c=0;c<b;++c)"^"===f[c]&&"^"!==f[c+1]&&(f[c]="");if(a.ignoreCase&&s)for(c=0;c<b;++c)j=f[c],a=j.charAt(0),j.length>=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p<d;++p){var g=a[p];if(g.ignoreCase)l=!0;else if(/[a-z]/i.test(g.source.replace(/\\u[\da-f]{4}|\\x[\da-f]{2}|\\[^UXux]/gi,""))){s=!0;l=!1;break}}for(var r=
{b:8,t:9,n:10,v:11,f:12,r:13},n=[],p=0,d=a.length;p<d;++p){g=a[p];if(g.global||g.multiline)throw Error(""+g);n.push("(?:"+y(g)+")")}return RegExp(n.join("|"),l?"gi":"g")}function M(a){function m(a){switch(a.nodeType){case 1:if(e.test(a.className))break;for(var g=a.firstChild;g;g=g.nextSibling)m(g);g=a.nodeName;if("BR"===g||"LI"===g)h[s]="\n",t[s<<1]=y++,t[s++<<1|1]=a;break;case 3:case 4:g=a.nodeValue,g.length&&(g=p?g.replace(/\r\n?/g,"\n"):g.replace(/[\t\n\r ]+/g," "),h[s]=g,t[s<<1]=y,y+=g.length,
t[s++<<1|1]=a)}}var e=/(?:^|\s)nocode(?:\s|$)/,h=[],y=0,t=[],s=0,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=document.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);m(a);return{a:h.join("").replace(/\n$/,""),c:t}}function B(a,m,e,h){m&&(a={a:m,d:a},e(a),h.push.apply(h,a.e))}function x(a,m){function e(a){for(var l=a.d,p=[l,"pln"],d=0,g=a.a.match(y)||[],r={},n=0,z=g.length;n<z;++n){var f=g[n],b=r[f],o=void 0,c;if(typeof b===
"string")c=!1;else{var i=h[f.charAt(0)];if(i)o=f.match(i[1]),b=i[0];else{for(c=0;c<t;++c)if(i=m[c],o=f.match(i[1])){b=i[0];break}o||(b="pln")}if((c=b.length>=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m),
l=[],p={},d=0,g=e.length;d<g;++d){var r=e[d],n=r[3];if(n)for(var k=n.length;--k>=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/,
q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/,
q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g,
"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a),
a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e}
for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g<d.length;++g)e(d[g]);m===(m|0)&&d[0].setAttribute("value",
m);var r=s.createElement("OL");r.className="linenums";for(var n=Math.max(0,m-1|0)||0,g=0,z=d.length;g<z;++g)l=d[g],l.className="L"+(g+n)%10,l.firstChild||l.appendChild(s.createTextNode("\xa0")),r.appendChild(l);a.appendChild(r)}function k(a,m){for(var e=m.length;--e>=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*</.test(m)?"default-markup":"default-code";return A[a]}function E(a){var m=
a.g;try{var e=M(a.h),h=e.a;a.a=h;a.c=e.c;a.d=0;C(m,h)(a);var k=/\bMSIE\b/.test(navigator.userAgent),m=/\n/g,t=a.a,s=t.length,e=0,l=a.c,p=l.length,h=0,d=a.e,g=d.length,a=0;d[g]=s;var r,n;for(n=r=0;n<g;)d[n]!==d[n+2]?(d[r++]=d[n++],d[r++]=d[n++]):n+=2;g=r;for(n=r=0;n<g;){for(var z=d[n],f=d[n+1],b=n+2;b+2<=g&&d[b+1]===f;)b+=2;d[r++]=z;d[r++]=f;n=b}for(d.length=r;h<p;){var o=l[h+2]||s,c=d[a+2]||s,b=Math.min(o,c),i=l[h+1],j;if(i.nodeType!==1&&(j=t.substring(e,b))){k&&(j=j.replace(m,"\r"));i.nodeValue=
j;var u=i.ownerDocument,v=u.createElement("SPAN");v.className=d[a+1];var x=i.parentNode;x.replaceChild(v,i);v.appendChild(i);e<o&&(l[h+1]=i=u.createTextNode(t.substring(b,o)),x.insertBefore(i,v.nextSibling))}e=b;e>=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"],
"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"],
H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"],
J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+
I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^<?]+/],["dec",/^<!\w[^>]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^<xmp\b[^>]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^<script\b[^>]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^<style\b[^>]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]),
["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css",
/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}),
["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes",
hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p<h.length&&l.now()<e;p++){var n=h[p],k=n.className;if(k.indexOf("prettyprint")>=0){var k=k.match(g),f,b;if(b=
!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p<h.length?setTimeout(m,
250):a&&a()}for(var e=[document.getElementsByTagName("pre"),document.getElementsByTagName("code"),document.getElementsByTagName("xmp")],h=[],k=0;k<e.length;++k)for(var t=0,s=e[k].length;t<s;++t)h.push(e[k][t]);var e=q,l=Date;l.now||(l={now:function(){return+new Date}});var p=0,d,g=/\blang(?:uage)?-([\w.]+)(?!\S)/;m()};window.PR={createSimpleLexer:x,registerLangHandler:k,sourceDecorator:u,PR_ATTRIB_NAME:"atn",PR_ATTRIB_VALUE:"atv",PR_COMMENT:"com",PR_DECLARATION:"dec",PR_KEYWORD:"kwd",PR_LITERAL:"lit",
PR_NOCODE:"nocode",PR_PLAIN:"pln",PR_PUNCTUATION:"pun",PR_SOURCE:"src",PR_STRING:"str",PR_TAG:"tag",PR_TYPE:"typ"}})();
docs/styles/jsdoc-default.css 0 → 100644
View file @ fde1c051
@font-face {
font-family: 'Open Sans';
font-weight: normal;
font-style: normal;
src: url('../fonts/OpenSans-Regular-webfont.eot');
src:
local('Open Sans'),
local('OpenSans'),
url('../fonts/OpenSans-Regular-webfont.eot?#iefix') format('embedded-opentype'),
url('../fonts/OpenSans-Regular-webfont.woff') format('woff'),
url('../fonts/OpenSans-Regular-webfont.svg#open_sansregular') format('svg');
}
@font-face {
font-family: 'Open Sans Light';
font-weight: normal;
font-style: normal;
src: url('../fonts/OpenSans-Light-webfont.eot');
src:
local('Open Sans Light'),
local('OpenSans Light'),
url('../fonts/OpenSans-Light-webfont.eot?#iefix') format('embedded-opentype'),
url('../fonts/OpenSans-Light-webfont.woff') format('woff'),
url('../fonts/OpenSans-Light-webfont.svg#open_sanslight') format('svg');
}
html
{
overflow: auto;
background-color: #fff;
font-size: 14px;
}
body
{
font-family: 'Open Sans', sans-serif;
line-height: 1.5;
color: #4d4e53;
background-color: white;
}
a, a:visited, a:active {
color: #0095dd;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
header
{
display: block;
padding: 0px 4px;
}
tt, code, kbd, samp {
font-family: Consolas, Monaco, 'Andale Mono', monospace;
}
.class-description {
font-size: 130%;
line-height: 140%;
margin-bottom: 1em;
margin-top: 1em;
}
.class-description:empty {
margin: 0;
}
#main {
float: left;
width: 70%;
}
article dl {
margin-bottom: 40px;
}
section
{
display: block;
background-color: #fff;
padding: 12px 24px;
border-bottom: 1px solid #ccc;
margin-right: 30px;
}
.variation {
display: none;
}
.signature-attributes {
font-size: 60%;
color: #aaa;
font-style: italic;
font-weight: lighter;
}
nav
{
display: block;
float: right;
margin-top: 28px;
width: 30%;
box-sizing: border-box;
border-left: 1px solid #ccc;
padding-left: 16px;
}
nav ul {
font-family: 'Lucida Grande', 'Lucida Sans Unicode', arial, sans-serif;
font-size: 100%;
line-height: 17px;
padding: 0;
margin: 0;
list-style-type: none;
}
nav ul a, nav ul a:visited, nav ul a:active {
font-family: Consolas, Monaco, 'Andale Mono', monospace;
line-height: 18px;
color: #4D4E53;
}
nav h3 {
margin-top: 12px;
}
nav li {
margin-top: 6px;
}
footer {
display: block;
padding: 6px;
margin-top: 12px;
font-style: italic;
font-size: 90%;
}
h1, h2, h3, h4 {
font-weight: 200;
margin: 0;
}
h1
{
font-family: 'Open Sans Light', sans-serif;
font-size: 48px;
letter-spacing: -2px;
margin: 12px 24px 20px;
}
h2, h3.subsection-title
{
font-size: 30px;
font-weight: 700;
letter-spacing: -1px;
margin-bottom: 12px;
}
h3
{
font-size: 24px;
letter-spacing: -0.5px;
margin-bottom: 12px;
}
h4
{
font-size: 18px;
letter-spacing: -0.33px;
margin-bottom: 12px;
color: #4d4e53;
}
h5, .container-overview .subsection-title
{
font-size: 120%;
font-weight: bold;
letter-spacing: -0.01em;
margin: 8px 0 3px 0;
}
h6
{
font-size: 100%;
letter-spacing: -0.01em;
margin: 6px 0 3px 0;
font-style: italic;
}
table
{
border-spacing: 0;
border: 0;
border-collapse: collapse;
}
td, th
{
border: 1px solid #ddd;
margin: 0px;
text-align: left;
vertical-align: top;
padding: 4px 6px;
display: table-cell;
}
thead tr
{
background-color: #ddd;
font-weight: bold;
}
th { border-right: 1px solid #aaa; }
tr > th:last-child { border-right: 1px solid #ddd; }
.ancestors { color: #999; }
.ancestors a
{
color: #999 !important;
text-decoration: none;
}
.clear
{
clear: both;
}
.important
{
font-weight: bold;
color: #950B02;
}
.yes-def {
text-indent: -1000px;
}
.type-signature {
color: #aaa;
}
.name, .signature {
font-family: Consolas, Monaco, 'Andale Mono', monospace;
}
.details { margin-top: 14px; border-left: 2px solid #DDD; }
.details dt { width: 120px; float: left; padding-left: 10px; padding-top: 6px; }
.details dd { margin-left: 70px; }
.details ul { margin: 0; }
.details ul { list-style-type: none; }
.details li { margin-left: 30px; padding-top: 6px; }
.details pre.prettyprint { margin: 0 }
.details .object-value { padding-top: 0; }
.description {
margin-bottom: 1em;
margin-top: 1em;
}
.code-caption
{
font-style: italic;
font-size: 107%;
margin: 0;
}
.prettyprint
{
border: 1px solid #ddd;
width: 80%;
overflow: auto;
}
.prettyprint.source {
width: inherit;
}
.prettyprint code
{
font-size: 100%;
line-height: 18px;
display: block;
padding: 4px 12px;
margin: 0;
background-color: #fff;
color: #4D4E53;
}
.prettyprint code span.line
{
display: inline-block;
}
.prettyprint.linenums
{
padding-left: 70px;
-webkit-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
}
.prettyprint.linenums ol
{
padding-left: 0;
}
.prettyprint.linenums li
{
border-left: 3px #ddd solid;
}
.prettyprint.linenums li.selected,
.prettyprint.linenums li.selected *
{
background-color: lightyellow;
}
.prettyprint.linenums li *
{
-webkit-user-select: text;
-moz-user-select: text;
-ms-user-select: text;
user-select: text;
}
.params .name, .props .name, .name code {
color: #4D4E53;
font-family: Consolas, Monaco, 'Andale Mono', monospace;
font-size: 100%;
}
.params td.description > p:first-child,
.props td.description > p:first-child
{
margin-top: 0;
padding-top: 0;
}
.params td.description > p:last-child,
.props td.description > p:last-child
{
margin-bottom: 0;
padding-bottom: 0;
}
.disabled {
color: #454545;
}
docs/styles/jsdoc.css 0 → 100644
View file @ fde1c051
@import url(https://fonts.googleapis.com/css?family=Montserrat:400,700);
* {
box-sizing: border-box
}
html, body {
height: 100%;
width: 100%;
}
body {
color: #4d4e53;
background-color: white;
margin: 0 auto;
padding: 0 20px;
font-family: 'Helvetica Neue', Helvetica, sans-serif;
font-size: 16px;
line-height: 160%;
}
a,
a:active {
color: #606;
text-decoration: none;
}
a:hover {
text-decoration: none;
}
article a {
border-bottom: 1px solid #ddd;
}
article a:hover, article a:active {
border-bottom-color: #222;
}
p, ul, ol, blockquote {
margin-bottom: 1em;
}
h1, h2, h3, h4, h5, h6 {
font-family: 'Montserrat', sans-serif;
}
h1, h2, h3, h4, h5, h6 {
color: #000;
font-weight: 400;
margin: 0;
}
h1 {
font-weight: 300;
font-size: 48px;
margin: 1em 0 .5em;
}
h1.page-title {
font-size: 48px;
margin: 1em 30px;
}
h2 {
font-size: 24px;
margin: 1.5em 0 .3em;
}
h3 {
font-size: 24px;
margin: 1.2em 0 .3em;
}
h4 {
font-size: 18px;
margin: 1em 0 .2em;
color: #4d4e53;
}
h4.name {
color: #fff;
background: #6d426d;
box-shadow: 0 .25em .5em #d3d3d3;
border-top: 1px solid #d3d3d3;
border-bottom: 1px solid #d3d3d3;
margin: 1.5em 0 0.5em;
padding: .75em 0 .75em 10px;
}
h4.name a {
color: #fc83ff;
}
h4.name a:hover {
border-bottom-color: #fc83ff;
}
h5, .container-overview .subsection-title {
font-size: 120%;
letter-spacing: -0.01em;
margin: 8px 0 3px 0;
}
h6 {
font-size: 100%;
letter-spacing: -0.01em;
margin: 6px 0 3px 0;
font-style: italic;
}
tt, code, kbd, samp {
font-family: Consolas, Monaco, 'Andale Mono', monospace;
background: #f4f4f4;
padding: 1px 5px;
}
.class-description {
font-size: 130%;
line-height: 140%;
margin-bottom: 1em;
margin-top: 1em;
}
.class-description:empty {
margin: 0
}
#main {
float: right;
min-width: 360px;
width: calc(100% - 240px);
}
header {
display: block
}
section {
display: block;
background-color: #fff;
padding: 0 0 0 30px;
}
.variation {
display: none
}
.signature-attributes {
font-size: 60%;
color: #eee;
font-style: italic;
font-weight: lighter;
}
nav {
float: left;
display: block;
width: 250px;
background: #fff;
overflow: auto;
position: fixed;
height: 100%;
}
nav h3 {
margin-top: 12px;
font-size: 13px;
text-transform: uppercase;
letter-spacing: 1px;
font-weight: 700;
line-height: 24px;
margin: 15px 0 10px;
padding: 0;
color: #000;
}
nav ul {
font-family: 'Lucida Grande', 'Lucida Sans Unicode', arial, sans-serif;
font-size: 100%;
line-height: 17px;
padding: 0;
margin: 0;
list-style-type: none;
}
nav ul a,
nav ul a:active {
font-family: 'Montserrat', sans-serif;
line-height: 18px;
padding: 0;
display: block;
font-size: 12px;
}
nav a:hover,
nav a:active {
color: #606;
}
nav > ul {
padding: 0 10px;
}
nav > ul > li > a {
color: #606;
}
nav ul ul {
margin-bottom: 10px
}
nav ul ul + ul {
margin-top: -10px;
}
nav ul ul a {
color: hsl(207, 1%, 60%);
border-left: 1px solid hsl(207, 10%, 86%);
}
nav ul ul a,
nav ul ul a:active {
padding-left: 20px
}
nav h2 {
font-size: 12px;
margin: 0;
padding: 0;
}
nav > h2 > a {
display: block;
margin: 10px 0 -10px;
color: #606 !important;
}
footer {
color: hsl(0, 0%, 28%);
margin-left: 250px;
display: block;
padding: 15px;
font-style: italic;
font-size: 90%;
}
.ancestors {
color: #999
}
.ancestors a {
color: #999 !important;
}
.clear {
clear: both
}
.important {
font-weight: bold;
color: #950B02;
}
.yes-def {
text-indent: -1000px
}
.type-signature {
color: #CA79CA
}
.type-signature:last-child {
color: #eee;
}
.name, .signature {
font-family: Consolas, Monaco, 'Andale Mono', monospace
}
.signature {
color: #fc83ff;
}
.details {
margin-top: 6px;
border-left: 2px solid #DDD;
line-height: 20px;
font-size: 14px;
}
.details dt {
width: 120px;
float: left;
padding-left: 10px;
}
.details dd {
margin-left: 70px;
margin-top: 6px;
margin-bottom: 6px;
}
.details ul {
margin: 0
}
.details ul {
list-style-type: none
}
.details pre.prettyprint {
margin: 0
}
.details .object-value {
padding-top: 0
}
.description {
margin-bottom: 1em;
margin-top: 1em;
}
.code-caption {
font-style: italic;
font-size: 107%;
margin: 0;
}
.prettyprint {
font-size: 14px;
overflow: auto;
}
.prettyprint.source {
width: inherit;
line-height: 18px;
display: block;
background-color: #0d152a;
color: #aeaeae;
}
.prettyprint code {
line-height: 18px;
display: block;
background-color: #0d152a;
color: #4D4E53;
}
.prettyprint > code {
padding: 15px;
}
.prettyprint .linenums code {
padding: 0 15px
}
.prettyprint .linenums li:first-of-type code {
padding-top: 15px
}
.prettyprint code span.line {
display: inline-block
}
.prettyprint.linenums {
padding-left: 70px;
-webkit-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
}
.prettyprint.linenums ol {
padding-left: 0
}
.prettyprint.linenums li {
border-left: 3px #34446B solid;
}
.prettyprint.linenums li.selected, .prettyprint.linenums li.selected * {
background-color: #34446B;
}
.prettyprint.linenums li * {
-webkit-user-select: text;
-moz-user-select: text;
-ms-user-select: text;
user-select: text;
}
.params, .props {
border-spacing: 0;
border: 1px solid #ddd;
border-collapse: collapse;
border-radius: 3px;
box-shadow: 0 1px 3px rgba(0,0,0,0.1);
width: 100%;
font-size: 14px;
margin: 1em 0;
}
.params .type {
white-space: nowrap;
}
.params code {
white-space: pre;
}
.params td, .params .name, .props .name, .name code {
color: #4D4E53;
font-family: Consolas, Monaco, 'Andale Mono', monospace;
font-size: 100%;
}
.params td, .params th, .props td, .props th {
margin: 0px;
text-align: left;
vertical-align: top;
padding: 10px;
display: table-cell;
}
.params td {
border-top: 1px solid #eee
}
.params thead tr, .props thead tr {
background-color: #fff;
font-weight: bold;
}
.params .params thead tr, .props .props thead tr {
background-color: #fff;
font-weight: bold;
}
.params td.description > p:first-child, .props td.description > p:first-child {
margin-top: 0;
padding-top: 0;
}
.params td.description > p:last-child, .props td.description > p:last-child {
margin-bottom: 0;
padding-bottom: 0;
}
span.param-type, .params td .param-type, .param-type dd {
color: #606;
font-family: Consolas, Monaco, 'Andale Mono', monospace
}
.param-type dt, .param-type dd {
display: inline-block
}
.param-type {
margin: 14px 0;
}
.disabled {
color: #454545
}
/* navicon button */
.navicon-button {
display: none;
position: relative;
padding: 2.0625rem 1.5rem;
transition: 0.25s;
cursor: pointer;
-webkit-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
opacity: .8;
}
.navicon-button .navicon:before, .navicon-button .navicon:after {
transition: 0.25s;
}
.navicon-button:hover {
transition: 0.5s;
opacity: 1;
}
.navicon-button:hover .navicon:before, .navicon-button:hover .navicon:after {
transition: 0.25s;
}
.navicon-button:hover .navicon:before {
top: .825rem;
}
.navicon-button:hover .navicon:after {
top: -.825rem;
}
/* navicon */
.navicon {
position: relative;
width: 2.5em;
height: .3125rem;
background: #000;
transition: 0.3s;
border-radius: 2.5rem;
}
.navicon:before, .navicon:after {
display: block;
content: "";
height: .3125rem;
width: 2.5rem;
background: #000;
position: absolute;
z-index: -1;
transition: 0.3s 0.25s;
border-radius: 1rem;
}
.navicon:before {
top: .625rem;
}
.navicon:after {
top: -.625rem;
}
/* open */
.nav-trigger:checked + label:not(.steps) .navicon:before,
.nav-trigger:checked + label:not(.steps) .navicon:after {
top: 0 !important;
}
.nav-trigger:checked + label .navicon:before,
.nav-trigger:checked + label .navicon:after {
transition: 0.5s;
}
/* Minus */
.nav-trigger:checked + label {
-webkit-transform: scale(0.75);
transform: scale(0.75);
}
/* × and + */
.nav-trigger:checked + label.plus .navicon,
.nav-trigger:checked + label.x .navicon {
background: transparent;
}
.nav-trigger:checked + label.plus .navicon:before,
.nav-trigger:checked + label.x .navicon:before {
-webkit-transform: rotate(-45deg);
transform: rotate(-45deg);
background: #FFF;
}
.nav-trigger:checked + label.plus .navicon:after,
.nav-trigger:checked + label.x .navicon:after {
-webkit-transform: rotate(45deg);
transform: rotate(45deg);
background: #FFF;
}
.nav-trigger:checked + label.plus {
-webkit-transform: scale(0.75) rotate(45deg);
transform: scale(0.75) rotate(45deg);
}
.nav-trigger:checked ~ nav {
left: 0 !important;
}
.nav-trigger:checked ~ .overlay {
display: block;
}
.nav-trigger {
position: fixed;
top: 0;
clip: rect(0, 0, 0, 0);
}
.overlay {
display: none;
position: fixed;
top: 0;
bottom: 0;
left: 0;
right: 0;
width: 100%;
height: 100%;
background: hsla(0, 0%, 0%, 0.5);
z-index: 1;
}
@media only screen and (min-width: 320px) and (max-width: 680px) {
body {
overflow-x: hidden;
}
nav {
background: #FFF;
width: 250px;
height: 100%;
position: fixed;
top: 0;
right: 0;
bottom: 0;
left: -250px;
z-index: 3;
padding: 0 10px;
transition: left 0.2s;
}
.navicon-button {
display: inline-block;
position: fixed;
top: 1.5em;
right: 0;
z-index: 2;
}
#main {
width: 100%;
min-width: 360px;
}
#main h1.page-title {
margin: 1em 0;
}
#main section {
padding: 0;
}
footer {
margin-left: 0;
}
}
/** Add a '#' to static members */
[data-type="member"] a::before {
content: '#';
display: inline-block;
margin-left: -14px;
margin-right: 5px;
}
docs/styles/prettify-jsdoc.css 0 → 100644
View file @ fde1c051
/* JSDoc prettify.js theme */
/* plain text */
.pln {
color: #000000;
font-weight: normal;
font-style: normal;
}
/* string content */
.str {
color: #006400;
font-weight: normal;
font-style: normal;
}
/* a keyword */
.kwd {
color: #000000;
font-weight: bold;
font-style: normal;
}
/* a comment */
.com {
font-weight: normal;
font-style: italic;
}
/* a type name */
.typ {
color: #000000;
font-weight: normal;
font-style: normal;
}
/* a literal value */
.lit {
color: #006400;
font-weight: normal;
font-style: normal;
}
/* punctuation */
.pun {
color: #000000;
font-weight: bold;
font-style: normal;
}
/* lisp open bracket */
.opn {
color: #000000;
font-weight: bold;
font-style: normal;
}
/* lisp close bracket */
.clo {
color: #000000;
font-weight: bold;
font-style: normal;
}
/* a markup tag name */
.tag {
color: #006400;
font-weight: normal;
font-style: normal;
}
/* a markup attribute name */
.atn {
color: #006400;
font-weight: normal;
font-style: normal;
}
/* a markup attribute value */
.atv {
color: #006400;
font-weight: normal;
font-style: normal;
}
/* a declaration */
.dec {
color: #000000;
font-weight: bold;
font-style: normal;
}
/* a variable name */
.var {
color: #000000;
font-weight: normal;
font-style: normal;
}
/* a function name */
.fun {
color: #000000;
font-weight: bold;
font-style: normal;
}
/* Specify class=linenums on a pre to get line numbering */
ol.linenums {
margin-top: 0;
margin-bottom: 0;
}
docs/styles/prettify-tomorrow.css 0 → 100644
View file @ fde1c051
/* Tomorrow Theme */
/* Original theme - https://github.com/chriskempson/tomorrow-theme */
/* Pretty printing styles. Used with prettify.js. */
/* SPAN elements with the classes below are added by prettyprint. */
/* plain text */
.pln {
color: #4d4d4c; }
@media screen {
/* string content */
.str {
color: #718c00; }
/* a keyword */
.kwd {
color: #8959a8; }
/* a comment */
.com {
color: #8e908c; }
/* a type name */
.typ {
color: #4271ae; }
/* a literal value */
.lit {
color: #f5871f; }
/* punctuation */
.pun {
color: #4d4d4c; }
/* lisp open bracket */
.opn {
color: #4d4d4c; }
/* lisp close bracket */
.clo {
color: #4d4d4c; }
/* a markup tag name */
.tag {
color: #c82829; }
/* a markup attribute name */
.atn {
color: #f5871f; }
/* a markup attribute value */
.atv {
color: #3e999f; }
/* a declaration */
.dec {
color: #f5871f; }
/* a variable name */
.var {
color: #c82829; }
/* a function name */
.fun {
color: #4271ae; } }
/* Use higher contrast and text-weight for printable form. */
@media print, projection {
.str {
color: #060; }
.kwd {
color: #006;
font-weight: bold; }
.com {
color: #600;
font-style: italic; }
.typ {
color: #404;
font-weight: bold; }
.lit {
color: #044; }
.pun, .opn, .clo {
color: #440; }
.tag {
color: #006;
font-weight: bold; }
.atn {
color: #404; }
.atv {
color: #060; } }
/* Style */
/*
pre.prettyprint {
background: white;
font-family: Consolas, Monaco, 'Andale Mono', monospace;
font-size: 12px;
line-height: 1.5;
border: 1px solid #ccc;
padding: 10px; }
*/
/* Specify class=linenums on a pre to get line numbering */
ol.linenums {
margin-top: 0;
margin-bottom: 0; }
/* IE indents via margin-left */
li.L0,
li.L1,
li.L2,
li.L3,
li.L4,
li.L5,
li.L6,
li.L7,
li.L8,
li.L9 {
/* */ }
/* Alternate shading for lines */
li.L1,
li.L3,
li.L5,
li.L7,
li.L9 {
/* */ }
docs/styles/prettify.css 0 → 100644
View file @ fde1c051
.pln {
color: #ddd;
}
/* string content */
.str {
color: #61ce3c;
}
/* a keyword */
.kwd {
color: #fbde2d;
}
/* a comment */
.com {
color: #aeaeae;
}
/* a type name */
.typ {
color: #8da6ce;
}
/* a literal value */
.lit {
color: #fbde2d;
}
/* punctuation */
.pun {
color: #ddd;
}
/* lisp open bracket */
.opn {
color: #000000;
}
/* lisp close bracket */
.clo {
color: #000000;
}
/* a markup tag name */
.tag {
color: #8da6ce;
}
/* a markup attribute name */
.atn {
color: #fbde2d;
}
/* a markup attribute value */
.atv {
color: #ddd;
}
/* a declaration */
.dec {
color: #EF5050;
}
/* a variable name */
.var {
color: #c82829;
}
/* a function name */
.fun {
color: #4271ae;
}
/* Specify class=linenums on a pre to get line numbering */
ol.linenums {
margin-top: 0;
margin-bottom: 0;
}
docs/util.js.html 0 → 100644
View file @ fde1c051
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>util.js - 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">util.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/**
* @module Util
* @description
* Internal Utility methods
*/
/**
* @function
* @param {string} str the string to convert
* @return {string} the string in under_scores
* @description
* Converts a string from camelCase to underscore_case
*/
function camelToUnderscore(str) {
return str.replace(/\W+/g, '-')
.replace(/([a-z\d])([A-Z])/g, '$1_$2')
.toLowerCase();
}
/**
* @function
* @param {string} str the string to convert
* @return {string} the string in camelCase
* @description
* Converts a string from underscore_case to camelCase
*/
function underscoreToCamel(str) {
return str.replace(/_([a-z])/g, g => g[1].toUpperCase());
}
/**
* @function
* @param {object} obj the object to massage the property names for
* @param {function} conversionFn the function to be called passing the object key
* @param {object} [newObject] the new object that is assembled (used in recursive calls)
* @return {object} a new object with the properties massaged by conversionFn
* @description
* Converts a string from underscore_case to camelCase
*/
function convert(obj, conversionFn, newObject) {
if (!obj) {
return obj;
}
if (!newObject) {
newObject = {};
}
Object.keys(obj).forEach((prop) => {
if (typeof obj[prop] === 'object') {
const convertObj = newObject[conversionFn(prop)] = {};
convert(obj[prop], conversionFn, convertObj);
} else {
newObject[conversionFn(prop)] = obj[prop];
}
});
return newObject;
}
module.exports = {
convert: convert,
camelToUnderscore: camelToUnderscore,
/**
* @function
* @methodof Util
* @param {object} a a javascript object
* @return {string} the jquery-like querystring to send to the api
* @description
* Ripped from https://github.com/knowledgecode/jquery-param
*/
serializeToQSParams: require('./param-serializer'),
underscoreToCamel: underscoreToCamel
};
</code></pre>
</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>
lib/api/client.js
View file @ fde1c051
......@@ -8,6 +8,14 @@ const util = require('../util');
* @param {object} options configuration options for this instance
* @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.
* @example
const challonge = require('challonge');
const client = challonge.createClient({
apiKey: '***yourAPIKey***'
});
*/
const Client = exports.Client = function(options) {
this.options = options || {};
......
lib/api/error-handler.js
View file @ fde1c051
/**
* Response code handler
* @module ErrorHandler
* @description
* Internally used to handle errors from the API
*/
/**
* @function
* @methodof ErrorHandler
*
* @param {object} res the http response object
* @param {object} resData the data contained in the response
* @param {Function} callback the users callback function to call
* @param {string} format the format of the response data (json, xml, etc)
* @description
* The following HTTP response codes are issued by the API.
* Handles HTTP response codes issued by the API.
* All other codes are the result of a request not reaching the application.
*/
exports.handle = function(res, resData, callback, format) {
......
lib/api/matches.js
View file @ fde1c051
......@@ -2,13 +2,15 @@ const util = require('util');
const Client = require('./client').Client;
/**
* @class Matches(options)
* @class Matches
* @param {object} options configuration options for this instance
* @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>
*/
const Matches = exports.Matches = function(options) {
Client.call(this, options); // call parent constructor
......@@ -17,6 +19,25 @@ const Matches = exports.Matches = function(options) {
// inherit from Client base object
util.inherits(Matches, Client);
/**
* @function
* @memberof Matches
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to get the matches from
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Retrieve a tournament's match list.
* See the {@link http://api.challonge.com/v1/documents/matches/index|Challonge API Doc} for a full list of object properties.
* @example
client.matches.index({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Matches.prototype.index = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/matches';
delete obj.id;
......@@ -24,6 +45,27 @@ Matches.prototype.index = function(obj) {
this.makeRequest(obj);
};
/**
* @function
* @memberof Matches
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to get the match from
* @param {string} obj.matchId The id of the match to get
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Retrieve a single match record for a tournament.
* See the {@link http://api.challonge.com/v1/documents/matches/show|Challonge API Doc} for a full list of object properties.
* @example
client.matches.show({
id: 'my-tournament-url',
matchId: '12345678',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Matches.prototype.show = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/matches/' + obj.matchId;
delete obj.id;
......@@ -32,6 +74,32 @@ Matches.prototype.show = function(obj) {
this.makeRequest(obj);
};
/**
* @function
* @memberof Matches
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to update the match in
* @param {string} obj.matchId The id of the match to update
* @param {object} obj.match The match object with updates. See challonge docs for available properties.
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Update/submit the score(s) for a match.
* See the {@link http://api.challonge.com/v1/documents/matches/update|Challonge API Doc} for a full list of object properties.
* @example
client.matches.update({
id: 'my-tournament-url',
matchId: '12345678',
match: {
scoresCsv: '3-0',
winnerId: '678910'
},
callback: (err, data) => {
console.log(err, data);
}
});
*/
Matches.prototype.update = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/matches/' + obj.matchId;
delete obj.id;
......
lib/api/participants.js
View file @ fde1c051
......@@ -2,16 +2,18 @@ const util = require('util');
const Client = require('./client').Client;
/**
* @class Participants(options)
* @class Participants
* @param {object} options configuration options for this instance
* @description
* Constructor function for the class to query Participants endpoints
* <pre>
* index GET tournaments/:tournament/participants
* create POST tournaments/:tournament/participants
* show GET tournaments/:tournament/participants/:participant_id
* update PUT tournaments/:tournament/participants/:participant_id
* destroy DELETE tournaments/:tournament/participants/:participant_id
* randomize GET tournaments/:tournament/participants/randomize
* </pre>
*/
const Participants = exports.Participants = function(options) {
Client.call(this, options); // call parent constructor
......@@ -20,6 +22,26 @@ const Participants = exports.Participants = function(options) {
// inherit from Client base object
util.inherits(Participants, Client);
/**
* @function
* @memberof Participants
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to get the participants from
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Retrieve a tournament's participant list.
* See the {@link http://api.challonge.com/v1/documents/participants/index|Challonge API Doc} for a full list of object properties.
* @example
client.participants.index({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Participants.prototype.index = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/participants';
delete obj.id;
......@@ -27,6 +49,29 @@ Participants.prototype.index = function(obj) {
this.makeRequest(obj);
};
/**
* @function
* @memberof Participants
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to create the participants in
* @param {object} obj.participant The participant to create. See challonge docs for available properties.
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Add a participant to a tournament (up until it is started).
* See the {@link http://api.challonge.com/v1/documents/participants/create|Challonge API Doc} for a full list of object properties.
* @example
client.participants.create({
id: 'my-tournament-url',
participant: {
name: 'Bob the Awesome'
},
callback: (err, data) => {
console.log(err, data);
}
});
*/
Participants.prototype.create = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/participants';
delete obj.id;
......@@ -34,6 +79,27 @@ Participants.prototype.create = function(obj) {
this.makeRequest(obj);
};
/**
* @function
* @memberof Participants
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to get a participant in
* @param {string} obj.participantId The id of the participant to get
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Retrieve a single participant record for a tournament.
* See the {@link http://api.challonge.com/v1/documents/participants/show|Challonge API Doc} for a full list of object properties.
* @example
client.participants.show({
id: 'my-tournament-url',
participantId: '123456',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Participants.prototype.show = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/participants/' + obj.participantId;
delete obj.id;
......@@ -42,6 +108,31 @@ Participants.prototype.show = function(obj) {
this.makeRequest(obj);
};
/**
* @function
* @memberof Participants
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to update a participant in
* @param {string} obj.participantId The id of the participant to update
* @param {object} obj.participant The participant object with updates. See challonge docs for available properties.
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Update the attributes of a tournament participant.
* See the {@link http://api.challonge.com/v1/documents/participants/update|Challonge API Doc} for a full list of object properties.
* @example
client.participants.update({
id: 'my-tournament-url',
participantId: '123456',
participant: {
name: 'Bob the Super Awesome'
},
callback: (err, data) => {
console.log(err, data);
}
});
*/
Participants.prototype.update = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/participants/' + obj.participantId;
delete obj.id;
......@@ -50,6 +141,27 @@ Participants.prototype.update = function(obj) {
this.makeRequest(obj);
};
/**
* @function
* @memberof Participants
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to remove a participant from
* @param {string} obj.participantId The id of the participant to remove
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* If the tournament has not started, delete a participant, automatically filling in the abandoned seed number. If tournament is underway, mark a participant inactive, automatically forfeiting his/her remaining matches.
* See the {@link http://api.challonge.com/v1/documents/participants/destroy|Challonge API Doc} for a full list of object properties.
* @example
client.participants.destroy({
id: 'my-tournament-url',
participantId: '123456',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Participants.prototype.destroy = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/participants/' + obj.participantId;
delete obj.id;
......@@ -58,6 +170,25 @@ Participants.prototype.destroy = function(obj) {
this.makeRequest(obj);
};
/**
* @function
* @memberof Participants
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to randomize the participant seeds in
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Randomize seeds among participants. Only applicable before a tournament has started.
* See the {@link http://api.challonge.com/v1/documents/participants/randomize|Challonge API Doc} for a full list of object properties.
* @example
client.participants.randomize({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Participants.prototype.randomize = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/participants/randomize';
delete obj.id;
......
lib/api/tournaments.js
View file @ fde1c051
......@@ -2,10 +2,11 @@ const util = require('util');
const Client = require('./client').Client;
/**
* @class Participants(options)
* @class Tournaments
* @param {object} options configuration options for this instance
* @description
* Constructor function for the class to query Participants endpoints
* Constructor function for the class to query Tournaments endpoints
* <pre>
* index GET tournaments
* create POST tournaments
* show GET tournaments/:tournament
......@@ -14,6 +15,7 @@ const Client = require('./client').Client;
* start POST tournaments/:tournament/start
* finalize POST tournaments/:tournament/finalize
* reset POST tournaments/:tournament/reset
* </pre>
*/
const Tournaments = exports.Tournaments = function(options) {
Client.call(this, options); // call parent constructor
......@@ -30,6 +32,22 @@ const Tournaments = exports.Tournaments = function(options) {
// inherit from Client base object
util.inherits(Tournaments, Client);
/**
* @function
* @memberof Tournaments
* @param {object} obj params to pass to the api request
* @description
* Retrieve a set of tournaments created with your account.
* See the {@link http://api.challonge.com/v1/documents/tournaments/index|Challonge API Doc} for a full list of object properties.
* @example
client.tournaments.index({
callback: (err, data) => {
console.log(err, data);
}
});
*/
Tournaments.prototype.index = function(obj) {
obj.method = 'GET';
if (this.getRawSubdomain()) {
......@@ -38,6 +56,29 @@ Tournaments.prototype.index = function(obj) {
this.makeRequest(obj);
};
/**
* @function
* @memberof Tournaments
* @param {object} obj params to pass to the api request
* @param {object} obj.tournament The tournament to create. See challonge docs for available properties.
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Create a new tournament.
* See the {@link http://api.challonge.com/v1/documents/tournaments/create|Challonge API Doc} for a full list of object properties.
* @example
client.tournaments.create({
tournament: {
name: 'My Tournament',
url: 'my-tournament-url',
tournamentType: 'single elimination',
},
callback: (err, data) => {
console.log(err, data);
}
});
*/
Tournaments.prototype.create = function(obj) {
if (this.getRawSubdomain()) {
obj.tournament.subdomain = this.getRawSubdomain();
......@@ -46,6 +87,25 @@ Tournaments.prototype.create = function(obj) {
this.makeRequest(obj);
};
/**
* @function
* @memberof Tournaments
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to get
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Retrieve a single tournament record created with your account.
* See the {@link http://api.challonge.com/v1/documents/tournaments/show|Challonge API Doc} for a full list of object properties.
* @example
client.tournaments.show({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Tournaments.prototype.show = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id;
delete obj.id;
......@@ -53,6 +113,29 @@ Tournaments.prototype.show = function(obj) {
this.makeRequest(obj);
};
/**
* @function
* @memberof Tournaments
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to update
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @param {object} obj.tournament The tournament object with updates. See challonge docs for available properties.
* @description
* Update a tournament's attributes.
* See the {@link http://api.challonge.com/v1/documents/tournaments/update|Challonge API Doc} for a full list of object properties.
* @example
client.tournaments.update({
id: 'my-tournament-url',
tournament: {
name: 'The New Tournament Name'
},
callback: (err, data) => {
console.log(err, data);
}
});
*/
Tournaments.prototype.update = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id;
delete obj.id;
......@@ -60,6 +143,25 @@ Tournaments.prototype.update = function(obj) {
this.makeRequest(obj);
};
/**
* @function
* @memberof Tournaments
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to remove
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Deletes a tournament along with all its associated records. There is no undo, so use with care!
* See the {@link http://api.challonge.com/v1/documents/tournaments/destroy|Challonge API Doc} for a full list of object properties.
* @example
client.tournaments.destroy({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Tournaments.prototype.destroy = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id;
delete obj.id;
......@@ -67,6 +169,25 @@ Tournaments.prototype.destroy = function(obj) {
this.makeRequest(obj);
};
/**
* @function
* @memberof Tournaments
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to start
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Start a tournament, opening up first round matches for score reporting. The tournament must have at least 2 participants.
* See the {@link http://api.challonge.com/v1/documents/tournaments/start|Challonge API Doc} for a full list of object properties.
* @example
client.tournaments.start({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Tournaments.prototype.start = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/start';
delete obj.id;
......@@ -74,6 +195,25 @@ Tournaments.prototype.start = function(obj) {
this.makeRequest(obj);
};
/**
* @function
* @memberof Tournaments
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to finalize
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Finalize a tournament that has had all match scores submitted, rendering its results permanent.
* See the {@link http://api.challonge.com/v1/documents/tournaments/finalize|Challonge API Doc} for a full list of object properties.
* @example
client.tournaments.finalize({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Tournaments.prototype.finalize = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/finalize';
delete obj.id;
......@@ -81,6 +221,25 @@ Tournaments.prototype.finalize = function(obj) {
this.makeRequest(obj);
};
/**
* @function
* @memberof Tournaments
* @param {object} obj params to pass to the api request
* @param {string} obj.id The url of the tournament to reset
* @param {function} obj.callback A method to call when the API returns. Arguments are (error, data)
* @description
* Reset a tournament, clearing all of its scores and attachments. You can then add/remove/edit participants before starting the tournament again.
* See the {@link http://api.challonge.com/v1/documents/tournaments/reset|Challonge API Doc} for a full list of object properties.
* @example
client.tournaments.reset({
id: 'my-tournament-url',
callback: (err, data) => {
console.log(err, data);
}
});
*/
Tournaments.prototype.reset = function(obj) {
obj.path = '/' + this.options.get('subdomain') + obj.id + '/reset';
delete obj.id;
......
lib/challonge.js
View file @ fde1c051
......@@ -6,6 +6,7 @@ endpoints.forEach(endpointName => {
/**
* @function createClient(options)
* @methodof modules:Client
* @param {object} options configuration options for this instance
* @returns {object} new api client instance
* @description
......
lib/param-serializer.js
View file @ fde1c051
/**
* @function serialize
* @function modules:Util#serialize
* @param {object} a a javascript object
* @return {string} the jquery-like querystring to send to the api
* @description
......
lib/util.js
View file @ fde1c051
/**
* @module Util
* @description
* Internal Utility methods
*/
/**
* @function
* @param {string} str the string to convert
* @return {string} the string in under_scores
* @description
* Converts a string from camelCase to underscore_case
*/
function camelToUnderscore(str) {
return str.replace(/\W+/g, '-')
.replace(/([a-z\d])([A-Z])/g, '$1_$2')
.toLowerCase();
}
/**
* @function
* @param {string} str the string to convert
* @return {string} the string in camelCase
* @description
* Converts a string from underscore_case to camelCase
*/
function underscoreToCamel(str) {
return str.replace(/_([a-z])/g, g => g[1].toUpperCase());
}
/**
* @function
* @param {object} obj the object to massage the property names for
* @param {function} conversionFn the function to be called passing the object key
* @param {object} [newObject] the new object that is assembled (used in recursive calls)
* @return {object} a new object with the properties massaged by conversionFn
* @description
* Converts a string from underscore_case to camelCase
*/
function convert(obj, conversionFn, newObject) {
if (!obj) {
return obj;
......@@ -30,6 +59,14 @@ function convert(obj, conversionFn, newObject) {
module.exports = {
convert: convert,
camelToUnderscore: camelToUnderscore,
/**
* @function
* @methodof Util
* @param {object} a a javascript object
* @return {string} the jquery-like querystring to send to the api
* @description
* Ripped from https://github.com/knowledgecode/jquery-param
*/
serializeToQSParams: require('./param-serializer'),
underscoreToCamel: underscoreToCamel
};
package.json
View file @ fde1c051
......@@ -29,25 +29,25 @@
],
"dependencies": {},
"devDependencies": {
"docdash": "^0.4.0",
"istanbul": "^0.4.5",
"jasmine": "^2.5.3",
"jsdoc": "^3.4.3",
"jsfmt": "^0.5.3",
"jshint": "^2.9.4",
"mockery": "^2.0.0"
},
"scripts": {
"test": "./node_modules/jasmine/bin/jasmine.js",
"coverage": "node ./node_modules/istanbul/lib/cli.js cover --include-all-sources ./node_modules/jasmine/bin/jasmine.js -x '**/spec/**' -x '**/key.js'",
"coverage": "node ./node_modules/istanbul/lib/cli.js cover --include-all-sources ./node_modules/jasmine/bin/jasmine.js -x '**/spec/**' -x '**/key.js' -x '**/docs/**'",
"format-lib": "./node_modules/jsfmt/bin/jsfmt -w ./lib ./*.js",
"format-spec": "./node_modules/jsfmt/bin/jsfmt -w ./spec",
"format": "npm run-script format-lib && npm run-script format-spec",
"lint-lib": "./node_modules/jshint/bin/jshint ./lib",
"lint-spec": "./node_modules/jshint/bin/jshint ./spec",
"lint": "npm run-script lint-lib && npm run-script lint-spec",
"integrate": "npm run-script test && npm run-script format && npm run-script lint"
"integrate": "npm run-script test && npm run-script format && npm run-script lint",
"docs": "./node_modules/.bin/jsdoc -r ./lib -d ./docs --readme README.md -t ./node_modules/docdash"
},
"engine": "node >= 6.0.x"
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment