docs: improve return type of getFirstDay()

Signed-off-by: Richard Steinmetz <richard@steinmetz.cloud>
nextcloud-libraries · Jul 22, 2024 · f1036d7 · f1036d7
1 parent 524d060
commit f1036d7
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/lib/date.ts b/lib/date.ts
@@ -10,9 +10,9 @@ declare let window: Nextcloud.v27.WindowWithGlobals
 /**
  * Get the first day of the week
  *
- * @return {number}
+ * @return {number} The first day where 0 is Sunday, 1 is Monday etc.
  */
-export function getFirstDay(): number {
+export function getFirstDay(): 0 | 1 | 2 | 3 | 4 | 5 | 6 {
 	if (typeof window.firstDay === 'undefined') {
 		console.warn('No firstDay found')
 		return 1