EditLinksParams
Parameters for editLinks.
Import:
import type { EditLinksParams } from 'obsidian-dev-utils/obsidian/link';Signature:
export interface EditLinksParams extends EditLinksOptionsExtends: EditLinksOptions
Properties
| Property | Type | Description |
|---|---|---|
| app | App | The Obsidian application instance. |
| pathOrFile | PathOrFile | The path or file to edit the links for. |
| shouldEditExternalLinks? | boolean | Whether to also edit external links parsed from the note body. When true, the converter also receives references for external links. |
| shouldEditFrontmatterExternalLinks? | boolean | Whether to also edit external links parsed from frontmatter values. When true, the converter also receives references for frontmatter external links. |
| shouldEditMultiValueFrontmatterExternalLinks? | boolean | Whether to also edit external links parsed from multi-link (multi-value) frontmatter values. When true, the converter also receives references for each external link within a multi-link frontmatter value (each located by its offsets, so only that link is spliced back in place). |
Methods
| Method | Returns | Description |
|---|---|---|
| linkConverter(this, link) | Promisable<MaybeReturn<string>> | The function that converts each link. |
Links to this page: