ResolveFolderNoteConfigParams

Parameters for resolveFolderNoteConfig.

Import:

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

Signature:

export interface ResolveFolderNoteConfigParams

Properties

Property	Type	Description
app	App	The Obsidian app instance.
extensions?	readonly string[]	The extensions a folder note may carry, with or without the leading dot, in resolution order. Ignored under FolderNoteLocation.Auto, which takes the installed plugin's answer whole.
isHidden?	boolean	Whether the folder note is hidden in the file explorer. Ignored under FolderNoteLocation.Auto.
location?	FolderNoteLocation	Where the note sits relative to its folder.
resolveName?	(folder: TFolder) => string	Names the folder note of a folder, WITHOUT its extension. Ignored under FolderNoteLocation.Auto, which names the note the way the installed plugin does. A callback rather than a name template, because a template needs a token vocabulary and this library has none to impose — a caller that has one ({{folderName}}, {{folderPath}}, …) renders it here.

---

Links to this page:

• resolveFolderNoteConfig