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

docs: improve code documentation

Browse source
This commit is contained in:
James Cook 2024-05-28 14:07:34 +01:00
parent cb8e252a89
commit 6d0942afe4
3 changed files with 30 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

12
src/core/parentClient.ts
View file

@ -4,12 +4,19 @@ import { BaseClient } from "../core/baseClient.ts";
import { API_BASE_PARENT, BASE_URL } from "../utils/consts.ts";
import { parseCookies } from "../utils/utils.ts";
/**
* Parent Client
* Parent Client.
* See {@link BaseClient} for all shared methods.
*
* @example
* ```ts
* import { ParentClient } from "classcharts-api";
* const client = new ParentClient("username", "password");
* await client.login();
* ```
*/
export class ParentClient extends BaseClient {
private password = "";
private email = "";
// @ts-expect-error Init in .login
public pupils: GetPupilsResponse;
/**
* @param email Parent's email address
@ -19,6 +26,7 @@ export class ParentClient extends BaseClient {
super(API_BASE_PARENT);
this.email = String(email);
this.password = String(password);
this.pupils = [];
}
/**