james/classcharts-api-js
1
0
Fork 0
mirror of https://github.com/classchartsapi/classcharts-api-js.git synced 2026-05-14 11:58:13 +00:00
Code Activity

feat: better documentation

Browse source
This commit is contained in:
James Cook 2023-04-16 20:47:40 +01:00
parent 58c5dfa1e4
commit 3aa119a063
12 changed files with 141 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

20
src/studentClient.ts
View file

@ -1,14 +1,22 @@
import { API_BASE_STUDENT, BASE_URL } from "./consts.js";
import { ClasschartsClient } from "./baseClient.js";
import { BaseClient } from "./baseClient.js";
import { parseCookies } from "./utils.js";
import ky from "ky-universal";
/**
* Student Client
*/
export class StudentClient extends ClasschartsClient {
public studentCode = "";
public dateOfBirth = "";
export class StudentClient extends BaseClient {
/**
* @property studentCode Classcharts student code
* @internal
*/
private studentCode = "";
/**
* @property dateOfBirth Student's date of birth
* @internal
*/
private dateOfBirth = "";
/**
*
@ -22,7 +30,7 @@ export class StudentClient extends ClasschartsClient {
}
/**
* Initialises the client and authenticates with classcharts
* Authenticates with classcharts
*/
async login(): Promise<void> {
if (!this.studentCode) throw new Error("Student Code not inputted");