codingame-api-node-ts
Version:
A CodinGame API node, that permits you to access all of the endpoints of this website. Wrote in TypeScript, so you can previsualize how the response will look like by checking the code.
172 lines (170 loc) • 9.31 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>codingame-api-node-ts</title>
<meta name="description" content="Documentation for codingame-api-node-ts">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<script async src="assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">codingame-api-node-ts</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<h1>codingame-api-node-ts</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<a href="#codingame-api-undocumented" id="codingame-api-undocumented" style="color: inherit; text-decoration: none;">
<h1>CodinGame API undocumented</h1>
</a>
<a href="#current-api-knowledge-and-advancement" id="current-api-knowledge-and-advancement" style="color: inherit; text-decoration: none;">
<h3>Current API knowledge and advancement</h3>
</a>
<p>To follow how far this package is, you can check the Trello : <a href="https://trello.com/b/q5vxDgBO/codingame-endpoints">https://trello.com/b/q5vxDgBO/codingame-endpoints</a></p>
<a href="#docs" id="docs" style="color: inherit; text-decoration: none;">
<h3>Docs</h3>
</a>
<p>You can see every current functions in the src/lib folder. You can see the types and the keys of the results by checking the interface result.</p>
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
<h3>Installation</h3>
</a>
<p>This is a node, so you are supposed to use it with Nodejs.<br>
To import the module, you need to do this in a command prompt :<br>
<code>npm install codingame-api-node-ts</code></p>
<a href="#example" id="example" style="color: inherit; text-decoration: none;">
<h3>Example</h3>
</a>
<p>This is the code to login to CodinGame</p>
<pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> { </span><span style="color: #0070C1">loginCodinGamer</span><span style="color: #000000"> } = </span><span style="color: #795E26">require</span><span style="color: #000000">(</span><span style="color: #A31515">'codingame-api-node-ts'</span><span style="color: #000000">)</span>
<span style="color: #AF00DB">try</span><span style="color: #000000"> {</span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">email</span><span style="color: #000000"> = </span><span style="color: #A31515">"api@test.example"</span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">password</span><span style="color: #000000"> = </span><span style="color: #A31515">"apitest"</span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">session</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #795E26">loginCodinGamer</span><span style="color: #000000">(</span><span style="color: #001080">email</span><span style="color: #000000">, </span><span style="color: #001080">password</span><span style="color: #000000">)</span>
<span style="color: #000000"> </span>
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">session</span><span style="color: #000000">)</span>
<span style="color: #000000">} </span><span style="color: #AF00DB">catch</span><span style="color: #000000"> (</span><span style="color: #001080">e</span><span style="color: #000000">) {</span>
<span style="color: #000000"> </span><span style="color: #008000">//axios error</span>
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">e</span><span style="color: #000000">)</span>
<span style="color: #000000">}</span>
</code></pre>
<p>You can see the result of this by going to <a href="https://github.com/Sigeth/codingame-api-node-ts/blob/main/src/lib/api/auth.ts">https://github.com/Sigeth/codingame-api-node-ts/blob/main/src/lib/api/auth.ts</a> and check the interface "ILoginCodinGamer", that contains every keys and results of the response.</p>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-interface">
<a href="interfaces/iclashleaderboard.html" class="tsd-kind-icon">IClash<wbr>Leaderboard</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/igloballeaderboard.html" class="tsd-kind-icon">IGlobal<wbr>Leaderboard</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ilogincodingamer.html" class="tsd-kind-icon">ILogin<wbr>Codin<wbr>Gamer</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ipuzzleminimalprogress.html" class="tsd-kind-icon">IPuzzle<wbr>Minimal<wbr>Progress</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ipuzzleprettyprogress.html" class="tsd-kind-icon">IPuzzle<wbr>Pretty<wbr>Progress</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ipuzzleprogress.html" class="tsd-kind-icon">IPuzzle<wbr>Progress</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#urls" class="tsd-kind-icon">urls</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#findallminimalprogress" class="tsd-kind-icon">find<wbr>All<wbr>Minimal<wbr>Progress</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#findprogressbyids" class="tsd-kind-icon">find<wbr>Progress<wbr>ByIds</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#findprogressbyprettyid" class="tsd-kind-icon">find<wbr>Progress<wbr>ByPretty<wbr>Id</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#getclashleaderboard" class="tsd-kind-icon">get<wbr>Clash<wbr>Leaderboard</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#getcookies" class="tsd-kind-icon">get<wbr>Cookies</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#getgloballeaderboard" class="tsd-kind-icon">get<wbr>Global<wbr>Leaderboard</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#logincodingamer" class="tsd-kind-icon">login<wbr>Codin<wbr>Gamer</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
</body>
</html>