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

fix: fix wording of docs

Browse source
This commit is contained in:
James Cook 2023-09-08 19:27:01 +01:00
parent 07021bc235
commit ad3b5c380b
3 changed files with 2 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/core/baseClient.ts
View file

@ -72,7 +72,7 @@ export class BaseClient {
* Makes a request to the ClassCharts API with the required authentication headers * Makes a request to the ClassCharts API with the required authentication headers
* *
* @param path Path to the API endpoint * @param path Path to the API endpoint
* @param kyOptions Ky (fetch library) request options * @param fetchOptions Request Options
* @param options * @param options
* @param options.revalidateToken Whether to revalidate the session ID if it is older than 3 minutes * @param options.revalidateToken Whether to revalidate the session ID if it is older than 3 minutes
* *

2
src/utils/consts.ts
View file

@ -2,4 +2,4 @@ export const BASE_URL = "https://www.classcharts.com";
export const API_BASE_STUDENT = `${BASE_URL}/apiv2student`; export const API_BASE_STUDENT = `${BASE_URL}/apiv2student`;
export const API_BASE_PARENT = `${BASE_URL}/apiv2parent`; export const API_BASE_PARENT = `${BASE_URL}/apiv2parent`;
export const PING_INTERVAL = 180 * 1000; // 3 minutes export const PING_INTERVAL = 60 * 3 * 1000; // 3 minutes

1
src/utils/utils.ts
View file

@ -14,7 +14,6 @@ export function parseCookies(input: string) {
} }
return output; return output;
} }
export function leftTrim(str: string) { export function leftTrim(str: string) {
return str.replace(/^\s+/g, ""); return str.replace(/^\s+/g, "");
} }