1
0
Fork 0
mirror of https://github.com/classchartsapi/classcharts-api-js.git synced 2026-05-14 19:59:37 +00:00
classcharts-api-js/readme.md

32 lines
858 B
Markdown
Raw Normal View History

2021-10-28 16:51:07 +01:00
# Classcharts API
2022-03-12 12:28:08 +00:00
A client for the classcharts API
2021-10-29 18:46:39 +01:00
2023-04-16 20:47:40 +01:00
- [Documentation](https://classchartsapi.github.io/classcharts-api-js/)
- [API Documentation (with library examples)](https://classchartsapi.github.io/api-docs/#introduction)
- [Discord](https://discord.gg/DTcwugcgZ2)
2021-10-29 18:46:39 +01:00
# Examples
2023-04-16 20:47:40 +01:00
2022-03-12 16:14:46 +00:00
Docs are very much a WIP, for any help with the library, please join the discord above
2021-10-29 18:46:39 +01:00
```typescript
2023-04-07 13:48:13 +01:00
import { StudentClient } from "classcharts-api";
2021-10-29 18:46:39 +01:00
async function main() {
2023-04-07 13:48:13 +01:00
const client = new StudentClient("classchartsCode", "01/1/2000");
2022-09-05 19:42:03 +01:00
await client.login();
2022-01-31 22:32:29 +00:00
console.log(
await client.getBehaviour({
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());
2021-10-29 18:46:39 +01:00
}
2022-01-31 22:32:29 +00:00
main();
2021-10-29 18:46:39 +01:00
```