resolveFolderNote

Finds a folder’s folder note — the one note whose properties describe the folder itself.

Never creates. A folder that has no folder note answers null, and so does the vault root under FolderNoteLocation.ParentFolder (nothing can sit beside it).

Import:

import { resolveFolderNote } from '@mnaoumov/obsidian-lib/folder-note';

Signature:

function resolveFolderNote(params: ResolveFolderNoteParams): TFile | null

Parameters:

Parameter	Type	Description
params	ResolveFolderNoteParams	The folder, and optionally the setup to resolve it with.

Returns: TFile | null — The folder note, or null when there is none.

---

Links to this page:

• ResolveFolderNoteParams
• renderInternalLink