Skip to content

Commit

Permalink
jsdoc: Note that parseFileContent() can only be called once per instance
Browse files Browse the repository at this point in the history
  • Loading branch information
claremacrae committed Dec 6, 2024
1 parent 8d28482 commit 6b1c2e6
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/Obsidian/FileParser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ export class FileParser {
this.dateFromFileName = new Lazy(() => DateFallback.fromPath(this.filePath));
}

/**
* **Warning**: This is designed to only be called **once per {@link FileParser} instance**.
*/
public parseFileContent() {
if (this.listItems === undefined) {
// When called via Cache, this function would never be called or files without list items.
Expand Down

0 comments on commit 6b1c2e6

Please sign in to comment.