FolderNoteConfig

A folder-note setup with FolderNoteLocation.Auto already resolved to a concrete answer.

Import:

import type { FolderNoteConfig } from 'obsidian-dev-utils/obsidian/folder-note';

Signature:

export interface FolderNoteConfig

Properties

Property	Type	Description
extensions	readonly string[]	The extensions a folder note may carry, WITHOUT the leading dot, in resolution order — the first one that names an existing file wins.
isHidden	boolean	Whether the folder note is hidden in the file explorer. Read rather than acted upon here: it changes nothing about WHICH file is the folder note, but a caller that reveals the note has to know there is nothing to reveal and fall back to revealing the folder.
location	FolderNoteLocation.InsideFolder | FolderNoteLocation.None | FolderNoteLocation.ParentFolder	Where the note sits relative to its folder.

Methods

Method	Returns	Description
resolveName(this, folder)	string	Names the folder note of a folder, WITHOUT its extension.

---

Links to this page:

• resolveFolderNoteConfig
• ResolveFolderNoteParams