gaschz/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-29 18:49:00 +01:00
Code Issues Actions 13 Packages Projects Releases Wiki Activity

chore(backend_api): document week note behaviour

Browse Source
This commit is contained in:
Elian Doran 2025-07-02 21:41:12 +03:00
parent 68bdd1336f
commit b20a8bc90b
No known key found for this signature in database
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
apps/server/src/services/backend_script_api.ts
View File

@ -255,8 +255,12 @@ export interface Api {
/** /**
* Returns week note for given date. If such a note doesn't exist, it is created. * Returns week note for given date. If such a note doesn't exist, it is created.
* *
* <p>
* If the calendar does not support week notes, this method will return `null`.
*
* @param date in YYYY-MM-DD format * @param date in YYYY-MM-DD format
* @param rootNote - specify calendar root note, normally leave empty to use the default calendar * @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; getWeekNote(date: string, rootNote: BNote): BNote | null;