Skip to content

GetFolderParams

Parameters for getFolder.

Import:

import type { GetFolderParams } from 'obsidian-dev-utils/obsidian/file-system';

Signature:

export interface GetFolderParams

Properties

PropertyTypeDescription
appAppThe Obsidian App instance.
isCaseInsensitive?booleanSpecifies whether to perform a case-insensitive search. When undefined or not specified, the behavior is determined by the actual file system.
pathOrFolderPathOrFolderThe path or folder identifier.
shouldIncludeNonExisting?booleanWhether to allow the folder to not exist. If true, a new folder is created for the provided path. If false, an error is thrown if the folder is not found.

Links to this page: