From b20a8bc90b1e7cc67ff43bc96894f72af939db66 Mon Sep 17 00:00:00 2001 From: Elian Doran Date: Wed, 2 Jul 2025 21:41:12 +0300 Subject: [PATCH] chore(backend_api): document week note behaviour --- apps/server/src/services/backend_script_api.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/apps/server/src/services/backend_script_api.ts b/apps/server/src/services/backend_script_api.ts index b3796637c..249d09ea0 100644 --- a/apps/server/src/services/backend_script_api.ts +++ b/apps/server/src/services/backend_script_api.ts @@ -255,8 +255,12 @@ export interface Api { /** * Returns week note for given date. If such a note doesn't exist, it is created. * + *

+ * If the calendar does not support week notes, this method will return `null`. + * * @param date in YYYY-MM-DD format * @param rootNote - specify calendar root note, normally leave empty to use the default calendar + * @return an existing or newly created week note, or `null` if the calendar does not support week notes. */ getWeekNote(date: string, rootNote: BNote): BNote | null;