mirror of
https://github.com/classchartsapi/classcharts-api-js.git
synced 2026-05-14 11:58:13 +00:00
34 lines
No EOL
4.8 KiB
HTML
34 lines
No EOL
4.8 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>classcharts-api</title><meta name="description" content="Documentation for classcharts-api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">classcharts-api</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> classcharts-api</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="#classcharts-api" id="classcharts-api" style="color: inherit; text-decoration: none;">
|
|
<h1>Classcharts API</h1>
|
|
</a>
|
|
<p>A very WIP client for the classcharts API</p>
|
|
<ul>
|
|
<li><a href="https://jamesatjaminit.github.io/classcharts-api/index.html">Documentation</a></li>
|
|
<li><a href="https://discord.gg/DTcwugcgZ2">Discord</a>
|
|
<a href="#examples" id="examples" style="color: inherit; text-decoration: none;">
|
|
<h1>Examples</h1>
|
|
</a>
|
|
Docs are very much a WIP, for any help with the libary, please join the discord above
|
|
```typescript
|
|
import { ClasschartsStudentClient } from "classcharts-api";
|
|
async function main() {
|
|
const client = new ClasschartsStudentClient("classchartsCode", "01/1/2000");
|
|
await client.init();
|
|
console.log(
|
|
await client.getBehaviour({
|
|
displayDate: "due_date",
|
|
fromDate: "20/01/2000",
|
|
toDate: "01/02/2000",
|
|
})
|
|
);
|
|
console.log(await client.getActivity());
|
|
console.log(await client.getStudentInfo());
|
|
console.log(await client.getActivity());
|
|
console.log(await client.getActivity());
|
|
}</li>
|
|
</ul>
|
|
<p>main();</p>
|
|
<pre><code>
|
|
</code></pre>
|
|
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="modules/baseClient.html">base<wbr/>Client</a></li><li class=" tsd-kind-module"><a href="modules/consts.html">consts</a></li><li class=" tsd-kind-module"><a href="modules/dummyClient.html">dummy<wbr/>Client</a></li><li class=" tsd-kind-module"><a href="modules/index.html">index</a></li><li class=" tsd-kind-module"><a href="modules/parentClient.html">parent<wbr/>Client</a></li><li class=" tsd-kind-module"><a href="modules/studentClient.html">student<wbr/>Client</a></li><li class=" tsd-kind-module"><a href="modules/types.html">types</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-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></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/main.js"></script></body></html> |