Skip to content

GetFileParams

Parameters for getFile.

Import:

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

Signature:

export interface GetFileParams

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.
pathOrFilePathOrFileThe path or file to retrieve the file for.
shouldIncludeNonExisting?booleanWhether to include a non-existing file. If true, a new file is created for the provided path. If false, an error is thrown if the file is not found.

Links to this page: