holm/egroupware
1
1
Fork 0
forked from extern/egroupware
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve holidays() return documentation

Browse Source
This commit is contained in:
nathan 2022-04-29 14:26:54 -06:00
parent b44f4ea30d
commit f54c7f40bb
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
api/js/etemplate/Et2Date/Holidays.ts
View File

@ -8,15 +8,15 @@ let _holiday_cache = {};
* Get a list of holidays for the given year
*
* Returns either a list of holidays indexed by date, in Ymd format:
* {20001225: {day: 14, month: 2, occurence: 2021, name: "Valentinstag"}}
* {20001225: [{day: 14, month: 2, occurence: 2021, name: "Valentinstag"}]}
* or a promise that resolves with the list.
*
* No need to cache the results, we do it here.
*
* @param year
* @returns Promise | Object
* @returns Promise<{[key: string]: Array<object>}>|{[key: string]: Array<object>}
*/
export function holidays(year) : Promise<Object> | {}
export function holidays(year) : Promise<{ [key : string] : Array<object> }> | { [key : string] : Array<object> }
{
// No country selected causes error, so skip if it's missing
if(!egw.preference('country', 'common'))