@mnaoumov/obsidian-lib 10.0.0 → 10.1.0

package/dist/lib/cjs/link.d.cts

@@ -414,6 +414,16 @@ export interface EditReferencesInContentParams {
      * @default `false`
      */
     readonly shouldEditMultiValueFrontmatterExternalLinks?: boolean;
+    /**
+     * A predicate choosing links to leave unchanged: for each reference it returns `true` for, the converter is
+     * not called, so the link stays byte-for-byte as written — its path, style, angle brackets and leading dot
+     * included. Use it to exclude links the caller decides on, for example by their resolved target path.
+     *
+     * Applied after the {@link isReferenceInHeading | heading} skip and the offset range.
+     *
+     * @default `undefined`
+     */
+    readonly shouldSkipReference?: (reference: Reference) => boolean;
     /**
      * Whether to leave every link inside a heading unchanged: the converter is not called for it, so it stays
      * byte-for-byte as written. A link in a heading is part of the heading's text, so rewriting it changes
@@ -485,6 +495,16 @@ export interface EditReferencesParams extends EditReferencesOptions {
      * @default `false`
      */
     readonly shouldEditMultiValueFrontmatterExternalLinks?: boolean;
+    /**
+     * A predicate choosing links to leave unchanged: for each reference it returns `true` for, the converter is
+     * not called, so the link stays byte-for-byte as written — its path, style, angle brackets and leading dot
+     * included. Use it to exclude links the caller decides on, for example by their resolved target path.
+     *
+     * Applied after the {@link isReferenceInHeading | heading} skip and the offset range.
+     *
+     * @default `undefined`
+     */
+    readonly shouldSkipReference?: (reference: Reference) => boolean;
     /**
      * Whether to leave every link inside a heading unchanged: the converter is not called for it, so it stays
      * byte-for-byte as written. A link in a heading is part of the heading's text, so rewriting it changes
@@ -795,6 +815,16 @@ export interface UpdateFileUrlLinksInContentParams {
      * @default `undefined`
      */
     readonly offsetRange?: OffsetRange;
+    /**
+     * A predicate choosing links to leave unchanged: for each reference it returns `true` for, the converter is
+     * not called, so the link stays byte-for-byte as written — its path, style, angle brackets and leading dot
+     * included. Use it to exclude links the caller decides on, for example by their resolved target path.
+     *
+     * Applied after the {@link isReferenceInHeading | heading} skip and the offset range.
+     *
+     * @default `undefined`
+     */
+    readonly shouldSkipReference?: (reference: Reference) => boolean;
     /**
      * Whether to leave every link inside a heading unchanged. See
      * {@link EditReferencesInContentParams.shouldSkipReferencesInHeadings}.
@@ -841,6 +871,16 @@ export interface UpdateFileUrlLinksInFileParams extends ProcessOptions {
      * The path or file to normalize the `file://` links in.
      */
     readonly pathOrFile: PathOrFile;
+    /**
+     * A predicate choosing links to leave unchanged: for each reference it returns `true` for, the converter is
+     * not called, so the link stays byte-for-byte as written — its path, style, angle brackets and leading dot
+     * included. Use it to exclude links the caller decides on, for example by their resolved target path.
+     *
+     * Applied after the {@link isReferenceInHeading | heading} skip and the offset range.
+     *
+     * @default `undefined`
+     */
+    readonly shouldSkipReference?: (reference: Reference) => boolean;
     /**
      * Whether to leave every link inside a heading unchanged. See {@link EditReferencesParams.shouldSkipReferencesInHeadings}.
      *
@@ -1060,6 +1100,16 @@ export interface UpdateReferencesInFileParams extends ProcessOptions {
      * @default `false`
      */
     readonly shouldIncludeAttachmentExtensionToEmbedAlias?: boolean;
+    /**
+     * A predicate choosing links to leave unchanged: for each reference it returns `true` for, the converter is
+     * not called, so the link stays byte-for-byte as written — its path, style, angle brackets and leading dot
+     * included. Use it to exclude links the caller decides on, for example by their resolved target path.
+     *
+     * Applied after the {@link isReferenceInHeading | heading} skip and the offset range.
+     *
+     * @default `undefined`
+     */
+    readonly shouldSkipReference?: (reference: Reference) => boolean;
     /**
      * Whether to leave every link inside a heading unchanged: it is neither converted nor restyled, so it
      * stays byte-for-byte as written. A link in a heading is part of the heading's text, so rewriting it
@@ -1205,6 +1255,16 @@ interface UpdateReferencesInContentParams {
      * @default `false`
      */
     readonly shouldIncludeAttachmentExtensionToEmbedAlias?: boolean;
+    /**
+     * A predicate choosing links to leave unchanged: for each reference it returns `true` for, the converter is
+     * not called, so the link stays byte-for-byte as written — its path, style, angle brackets and leading dot
+     * included. Use it to exclude links the caller decides on, for example by their resolved target path.
+     *
+     * Applied after the {@link isReferenceInHeading | heading} skip and the offset range.
+     *
+     * @default `undefined`
+     */
+    readonly shouldSkipReference?: (reference: Reference) => boolean;
     /**
      * Whether to leave every link inside a heading unchanged: it is neither converted nor restyled, so it
      * stays byte-for-byte as written. A link in a heading is part of the heading's text, so rewriting it