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

docs: improve code documentation

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

View file

@ -1,23 +1,31 @@
import { API_BASE_STUDENT, BASE_URL } from "../utils/consts.ts";
import { BaseClient } from "../core/baseClient.ts";
import { parseCookies } from "../utils/utils.ts";
import {
import type {
GetStudentCodeOptions,
GetStudentCodeResponse,
RewardPurchaseResponse,
RewardsResponse,
} from "../types.ts";
/**
* Student Client
* Student Client.
* See {@link BaseClient} for all shared methods.
*
* @example
* ```ts
* import { StudentClient } from "classcharts-api";
* // Date of birth MUST in the format DD/MM/YYYY
* const client = new StudentClient("classchartsCode", "01/01/2000");
* await client.login();
* ```
*/
export class StudentClient extends BaseClient {
/**
* @property studentCode ClassCharts student code
* ClassCharts student code
*/
private studentCode = "";
/**
* @property dateOfBirth Student's date of birth
* Student's date of birth
*/
private dateOfBirth = "";