Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add getCurrentSchoolyear() #109

Merged
merged 1 commit into from
Feb 16, 2024
Merged

Add getCurrentSchoolyear() #109

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions src/base.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -764,6 +764,24 @@ export class Base {
return await this._request('getStatusData', {}, validateSession);
}

/**
* Get the current school year
* @param [validateSession=true]
* @returns {Promise.<SchoolYear>}
*/
async getCurrentSchoolyear(validateSession = true): Promise<SchoolYear> {
const data = await this._request<InternalSchoolYear>('getCurrentSchoolyear', {}, validateSession);

if (!data) throw new Error('Failed to retrieve current school year');

return {
name: data.name,
id: data.id,
startDate: Base.convertUntisDate(data.startDate),
endDate: Base.convertUntisDate(data.endDate),
};
}

/**
* Convert a JS Date Object to a WebUntis date string
* @param {Date} date
Expand Down
Loading