feat: add getCurrentSchoolyear() (#109)

SchoolUtils · Feb 16, 2024 · c9fa544 · c9fa544
1 parent 2c51a44
commit c9fa544
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/src/base.ts b/src/base.ts
@@ -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