RenameDeleteHandlerSettings

Settings for the rename/delete handler.

Import:

import type { RenameDeleteHandlerSettings } from 'obsidian-dev-utils/obsidian/components/rename-delete-handler-component';

Signature:

export interface RenameDeleteHandlerSettings

Properties

Property	Type	Description
emptyFolderBehavior	EmptyFolderBehavior	A behavior of the rename/delete handler when deleting empty folders.
shouldDeleteConflictingAttachments	boolean	Whether to delete conflicting attachments.
shouldHandleDeletions	boolean	Whether to handle deletions.
shouldHandleRenames	boolean	Whether to handle renames.
shouldRenameAttachmentFiles	boolean	Whether to rename attachment files when a note is renamed.
shouldRenameAttachmentFolder	boolean	Whether to rename attachment folder when a note is renamed.
shouldUpdateFileNameAliases	boolean	Whether to update file name aliases when a note is renamed.

Methods

Method	Returns	Description
getRescuePath(params)	Promise<null | string>	Where to move an attachment that a deletion would otherwise strand — one that survives because another note still references it, but is left sitting in a folder whose owning note is gone. Deciding the destination is the plugin's attachment-path policy, which is why the handler asks rather than guesses. Returning null — or not implementing this at all — keeps the attachment where it is, which is the behavior every consumer had before this member existed.
isNote(path)	boolean	Whether the path is a note.
isPathIgnored(path)	boolean	Whether to ignore the path.

---

Links to this page:

• RenameDeleteHandlerComponent