RecordAttachmentPlacementParams
Parameters for recordAttachmentPlacement.
Import:
import type { RecordAttachmentPlacementParams } from '@mnaoumov/obsidian-lib/misplaced-attachment';Signature:
export interface RecordAttachmentPlacementParamsProperties
| Property | Type | Description |
|---|---|---|
| app | App | The Obsidian app instance. |
| attachmentFile | TFile | The file the reference resolved to. Pass only references that resolved: an unresolved one is a broken link, not a misplaced attachment. |
| index | MisplacedAttachmentIndex | The index the verdict is recorded in. |
| isPathIgnored? | (path: string) => boolean | Whether a path is never judged, for example because the user excluded it. Defaults to judging every path. |
| isSharedAttachmentPath? | (path: string) => boolean | Whether 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) => boolean | Whether a note is treated as an attachment (an .excalidraw.md file, say), and so judged here. Defaults to no note being one. |
| notePath | string | The vault-relative path of the note that makes the reference. |
| reference | Reference | The reference, kept in the entry so a report can name its line or frontmatter key. |
Links to this page: