imnyang/comcigan.ts
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

fix: add docstrings

Browse source
This commit is contained in:
Starcea 2024-06-28 00:34:27 +09:00
commit 0b5b89e91b
No known key found for this signature in database
GPG key ID: B7A77E32374911E1
3 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

3
src/client.ts
View file

@ -18,6 +18,7 @@ export default class Comcigan {
private readonly dataManager = new DataManager(this.rest)
/** 학교를 검색합니다. */
async searchSchools(schoolName: string): Promise<School[]> {
const { mainRoute, searchRoute } = await this.dataManager.getData()
const res = await this.rest.get(
@ -34,6 +35,7 @@ export default class Comcigan {
}))
}
/** 학교 코드를 이용해 학교 시간표를 불러옵니다. */
async getRawTimetable(schoolCode: number): Promise<Timetable[][][][]> {
const { mainRoute, timetableRoute, teacherCode, dayCode, subjectCode } =
await this.dataManager.getData()
@ -62,6 +64,7 @@ export default class Comcigan {
)
}
/** 학교 코드를 이용해 학교 시간표를 불러오고, `TimetableManager`로 변환해 사용할 수 있는 형태로 제공합니다. */
async getTimetable(schoolCode: number) {
return new TimetableManager(await this.getRawTimetable(schoolCode))
}