kahoot.js-latest

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Namespace: defaults</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <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">Namespace: defaults</h1> <section> <header> <h2> <span class="ancestors"><a href="Client.html">Client</a>#</span>defaults</h2> </header> <article> <div class="container-overview"> <div class="description">The default settings for the client.</div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="kahoot.js.html">kahoot.js</a>, <a href="kahoot.js.html#line365">line 365</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Namespaces</h3> <dl> <dt><a href="Client_defaults.modules.html">modules</a></dt> <dd></dd> <dt><a href="Client_defaults.options.html">options</a></dt> <dd></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id=".proxy"><span class="type-signature">(static) </span>proxy<span class="signature">(options)</span><span class="type-signature"> → {Object}</span></h4> <div class="description"> A function to proxy kahoot.js-updated's http requests </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">The default <a href="https://nodejs.org/api/http.html#http_http_request_options_callback">HTTP Request</a> options used by Kahoot.js</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="kahoot.js.html">kahoot.js</a>, <a href="kahoot.js.html#line411">line 411</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> The modified <a href="https://nodejs.org/api/http.html#http_http_request_options_callback">HTTP Request</a> options to proxy the request. </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Object</span> </dd> </dl> <h4 class="name" id=".wsproxy"><span class="type-signature">(static) </span>wsproxy<span class="signature">(url)</span><span class="type-signature"> → {<a href="Client_defaults.wsproxy.WsProxyReturn.html">Client#defaults.wsproxy.WsProxyReturn</a>}</span></h4> <div class="description"> A function to proxy kahoot.js-updated's websocket requests </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>url</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The default websocket URI that Kahoot.JS sends the socket to.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="kahoot.js.html">kahoot.js</a>, <a href="kahoot.js.html#line418">line 418</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <a href="https://github.com/websockets/ws/blob/HEAD/doc/ws.md#new-websocketaddress-protocols-options">WS Options</a> used to create the proxied socket. You may also return a WebSocket itself. See Documentation.md </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="Client_defaults.wsproxy.WsProxyReturn.html">Client#defaults.wsproxy.WsProxyReturn</a></span> </dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="Client_data.html">data</a></li><li><a href="Client_defaults.html">defaults</a></li><li><a href="Client_defaults.modules.html">modules</a></li><li><a href="Client_defaults.options.html">options</a></li><li><a href="Client_defaults.wsproxy.WsProxyReturn.html">WsProxyReturn</a></li><li><a href="Client_quiz.html">quiz</a></li><li><a href="Client_quiz.currentQuestion.html">currentQuestion</a></li><li><a href="LiveEventTimetrack.html">LiveEventTimetrack</a></li><li><a href="Nemesis.html">Nemesis</a></li><li><a href="PointsData.html">PointsData</a></li><li><a href="StreakPoints.html">StreakPoints</a></li></ul><h3>Classes</h3><ul><li><a href="Client.html">Client</a></li></ul><h3>Events</h3><ul><li><a href="Client.html#event:Disconnect">Disconnect</a></li><li><a href="Client.html#event:Feedback">Feedback</a></li><li><a href="Client.html#event:GameReset">GameReset</a></li><li><a href="Client.html#event:Joined">Joined</a></li><li><a href="Client.html#event:NameAccept">NameAccept</a></li><li><a href="Client.html#event:Podium">Podium</a></li><li><a href="Client.html#event:QuestionEnd">QuestionEnd</a></li><li><a href="Client.html#event:QuestionReady">QuestionReady</a></li><li><a href="Client.html#event:QuestionStart">QuestionStart</a></li><li><a href="Client.html#event:QuizEnd">QuizEnd</a></li><li><a href="Client.html#event:QuizStart">QuizStart</a></li><li><a href="Client.html#event:RecoveryData">RecoveryData</a></li><li><a href="Client.html#event:TeamAccept">TeamAccept</a></li><li><a href="Client.html#event:TeamTalk">TeamTalk</a></li><li><a href="Client.html#event:TimeOver">TimeOver</a></li><li><a href="Client.html#event:TwoFactorCorrect">TwoFactorCorrect</a></li><li><a href="Client.html#event:TwoFactorReset">TwoFactorReset</a></li><li><a href="Client.html#event:TwoFactorWrong">TwoFactorWrong</a></li></ul><h3>Global</h3><ul><li><a href="global.html#EventEmitter">EventEmitter</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sun Oct 11 2020 19:45:43 GMT-0700 (Pacific Daylight Time) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>