ResolveFolderNoteParams
Parameters for resolveFolderNote.
Import:
import type { ResolveFolderNoteParams } from 'obsidian-dev-utils/obsidian/folder-note';Signature:
export interface ResolveFolderNoteParamsProperties
| Property | Type | Description |
|---|---|---|
| app | App | The Obsidian app instance. |
| config? | FolderNoteConfig | The already-resolved setup to use. Omitted means FolderNoteLocation.Auto — the setup is resolved on the spot, which is what makes resolveFolderNote({ app, folder }) the one-liner every caller wants. Pass one when the same setup is used more than once, or when its FolderNoteConfig.isHidden is needed alongside the note. |
| folder | TFolder | The folder whose folder note is wanted. Read AFTER any rename: the note is named from the folder's CURRENT name, and a folder-notes install with syncFolderName on will have renamed it already. |
Links to this page: