Tools/Notes
1
0
Fork 0
mirror of https://github.com/TriliumNext/Notes.git synced 2025-08-12 20:02:28 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore(api): document getWeekNote

Browse Source
This commit is contained in:
Elian Doran 2025-04-14 18:36:54 +03:00
parent 34a0470d72
commit 5675e6366b
No known key found for this signature in database
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/services/date_notes.ts
View File

@ -401,6 +401,13 @@ function getWeekFirstDayNote(dateStr: string, rootNote: BNote | null = null) {
return getDayNote(weekStartDate.format("YYYY-MM-DD"), rootNote); return getDayNote(weekStartDate.format("YYYY-MM-DD"), rootNote);
} }
/**
* Returns the {@link BNote} corresponding to the given week. If there is no note associated yet to that week, it will be created and returned instead.
*
* @param weekStr the week for which to return the corresponding note, in the format `2024-W04`.
* @param _rootNote a {@link BNote} representing the calendar root, or {@code null} or not specified to use the default root calendar note.
* @returns a Promise that resolves to the {@link BNote} corresponding to the week note.
*/
async function getWeekNote(weekStr: string, _rootNote: BNote | null = null): Promise<BNote | null> { async function getWeekNote(weekStr: string, _rootNote: BNote | null = null): Promise<BNote | null> {
const rootNote = _rootNote || getRootCalendarNote(); const rootNote = _rootNote || getRootCalendarNote();
if (!rootNote.hasLabel("enableWeekNote")) { if (!rootNote.hasLabel("enableWeekNote")) {