Skip to content

RecordAttachmentPlacementParams

Parameters for recordAttachmentPlacement.

Import:

import type { RecordAttachmentPlacementParams } from '@mnaoumov/obsidian-lib/misplaced-attachment';

Signature:

export interface RecordAttachmentPlacementParams

Properties

PropertyTypeDescription
appAppThe Obsidian app instance.
attachmentFileTFileThe file the reference resolved to. Pass only references that resolved: an unresolved one is a broken link, not a misplaced attachment.
indexMisplacedAttachmentIndexThe index the verdict is recorded in.
isPathIgnored?(path: string) => booleanWhether a path is never judged, for example because the user excluded it. Defaults to judging every path.
isSharedAttachmentPath?(path: string) => booleanWhether a path lies in a shared attachment location, which is anybody's folder, so no reference into it is external. Defaults to no shared location.
isTreatedAsAttachment?(path: string) => booleanWhether a note is treated as an attachment (an .excalidraw.md file, say), and so judged here. Defaults to no note being one.
notePathstringThe vault-relative path of the note that makes the reference.
referenceReferenceThe reference, kept in the entry so a report can name its line or frontmatter key.

Links to this page: