obsidian/vault

This module provides utility functions for working with the Obsidian Vault.

Interfaces

Interface	Description
ContentArgs	Arguments for process.
CopySafeParams	Parameters for copySafe.
GetAbstractFilePathSafeParams	Parameters for getAbstractFilePathSafe.
GetOrCreateAbstractFileSafeParams	Parameters for getOrCreateAbstractFileSafe.
GetSafeRenamePathParams	Parameters for getSafeRenamePath.
InvokeWithFileSystemLockParams	Parameters for invokeWithFileSystemLock.
IsChildOrSelfParams	Parameters for isChildOrSelf.
IsChildParams	Parameters for isChild.
ProcessOptions	Options for process.
ProcessParams	Parameters for process.
RenameSafeParams	Parameters for renameSafe.

Functions

Function	Description
copySafe	Copies a file safely in the vault.
createFolderSafe	Creates a folder safely in the specified path.
createTempFile	Creates a temporary file in the vault with parent folders if needed.
createTempFolder	Creates a temporary folder in the vault with parent folders if needed.
deleteEmptyFolder	Deletes an empty folder.
deleteEmptyFolderHierarchy	Removes empty folder hierarchy starting from the given folder.
getAbstractFilePathSafe	Gets a safe path for a file or folder.
getAvailablePath	Gets an available path for a file in the vault.
getFilePathSafe	Gets a safe file path for a file or folder.
getFolderPathSafe	Gets a safe folder path for a file or folder.
getMarkdownFilesSorted	Retrieves an array of Markdown files from the app’s vault and sorts them alphabetically by their file path.
getNoteFilesSorted	Retrieves an array of all note files from the app’s vault and sorts them alphabetically by their file path.
getOrCreateAbstractFileSafe	Gets or creates an abstract file safely in the specified path. If the file already exists, it will be returned. If the file does not exist, it will be created and returned.
getOrCreateFileSafe	Gets or creates a file safely in the specified path. If the file already exists, it will be returned. If the file does not exist, it will be created and returned.
getOrCreateFolderSafe	Gets or creates a folder safely in the specified path. If the folder already exists, it will be returned. If the folder does not exist, it will be created and returned.
getSafeRenamePath	Gets a safe rename path for a file.
invokeWithFileSystemLock	Invokes a function with the file system lock.
isChild	Checks if a path or file is a child of another path or file.
isChildOrSelf	Checks if a path or file is a child or self of another path or file.
isEmptyFolder	Checks if a folder is empty.
listSafe	Safely lists the files and folders at the specified path in the vault.
process	Processes a file with retry logic, updating its content based on a provided value or function.
readSafe	Reads the content of a file safely from the vault. It covers the case when the file was removed during the reading.
renameSafe	Renames a file safely in the vault. If the new path already exists, the file will be renamed to an available path.
saveNote	Saves the specified note in the Obsidian app.
trashSafe	Trashes an abstract file safely from the vault.