obsidian-dev-utils 80.1.0 → 82.0.0-beta.0

package/dist/lib/esm/obsidian/link.d.mts

@@ -88,7 +88,9 @@ export interface ConvertLinkParams {
      */
     readonly oldSourcePathOrFile?: PathOrFile;
     /**
-     * Whether to update file name alias. Defaults to `true`.
+     * Whether to update file name alias.
+     *
+     * @default `true`
      */
     readonly shouldUpdateFileNameAlias?: boolean;
 }
@@ -96,10 +98,88 @@ export interface ConvertLinkParams {
  * Options for {@link editBacklinks}.
  */
 export type EditBacklinksOptions = ProcessOptions;
+/**
+ * Parameters for {@link editBacklinks}.
+ */
+export interface EditBacklinksParams extends EditBacklinksOptions {
+    /**
+     * The Obsidian application instance.
+     */
+    readonly app: App;
+    /**
+     * The function that converts each link.
+     */
+    linkConverter(this: void, link: Reference): Promisable<MaybeReturn<string>>;
+    /**
+     * The path or file to edit the backlinks for.
+     */
+    readonly pathOrFile: PathOrFile;
+}
+/**
+ * Parameters for {@link editLinksInContent}.
+ */
+export interface EditLinksInContentParams {
+    /**
+     * The abort signal to control the execution of the function.
+     */
+    readonly abortSignal?: AbortSignal;
+    /**
+     * The Obsidian application instance.
+     */
+    readonly app: App;
+    /**
+     * The content to edit the links in.
+     */
+    readonly content: string;
+    /**
+     * The function that converts each link.
+     */
+    linkConverter(this: void, link: Reference): Promisable<MaybeReturn<string>>;
+}
 /**
  * Options for {@link editLinks}.
  */
 export type EditLinksOptions = ProcessOptions;
+/**
+ * Parameters for {@link editLinks}.
+ */
+export interface EditLinksParams extends EditLinksOptions {
+    /**
+     * The Obsidian application instance.
+     */
+    readonly app: App;
+    /**
+     * The function that converts each link.
+     */
+    linkConverter(this: void, link: Reference): Promisable<MaybeReturn<string>>;
+    /**
+     * The path or file to edit the links for.
+     */
+    readonly pathOrFile: PathOrFile;
+}
+/**
+ * Parameters for {@link extractLinkFile}.
+ */
+export interface ExtractLinkFileParams {
+    /**
+     * The Obsidian application instance.
+     */
+    readonly app: App;
+    /**
+     * The reference cache for the link.
+     */
+    readonly link: Reference;
+    /**
+     * Whether to allow non-existing files.
+     *
+     * @default `false`
+     */
+    readonly shouldAllowNonExistingFile?: boolean;
+    /**
+     * The source path or file.
+     */
+    readonly sourcePathOrFile: PathOrFile;
+}
 /**
  * Params for {@link generateMarkdownLink}.
  */
@@ -124,29 +204,35 @@ export interface GenerateMarkdownLinkParams {
      */
     readonly isEmbed?: boolean;
     /**
-     * Whether to allow an empty alias for embeds. Defaults to `true`.
+     * Whether to allow an empty alias for embeds.
      *
      * Applicable only if the result link style is {@link LinkStyle.Markdown}.
      *
      * If `true`: `![](foo.png)`.
      *
      * If `false`: `![foo](foo.png)`.
+     *
+     * @default `true`
      */
     readonly isEmptyEmbedAliasAllowed?: boolean;
     /**
-     * Whether to allow non-existing files. Defaults to `false`.
+     * Whether to allow non-existing files.
      *
      * If `false` and {@link targetPathOrFile} is a non-existing file, an error will be thrown.
+     *
+     * @default `false`
      */
     readonly isNonExistingFileAllowed?: boolean;
     /**
-     * Whether to allow a single subpath. Defaults to `true`.
+     * Whether to allow a single subpath.
      *
      * Applicable only if {@link targetPathOrFile} and {@link sourcePathOrFile} are the same file.
      *
      * If `true`: `[[#subpath]]`.
      *
      * If `false`: `[[source#subpath]]`
+     *
+     * @default `true`
      */
     readonly isSingleSubpathAllowed?: boolean;
     /**
@@ -172,53 +258,63 @@ export interface GenerateMarkdownLinkParams {
      */
     readonly originalLink?: string;
     /**
-     * Whether to escape the alias. Defaults to `false`.
+     * Whether to escape the alias.
      *
      * Applicable only if the result link style is {@link LinkStyle.Markdown}.
      *
      * If `true`: `[\*\*alias\*\*](link.md)`.
      *
      * If `false`: `[**alias**](link.md)`.
+     *
+     * @default `false`
      */
     readonly shouldEscapeAlias?: boolean;
     /**
-     * Whether to include the attachment extension in the embed alias. Defaults to `false`.
+     * Whether to include the attachment extension in the embed alias.
      *
      * Applicable only if {@link isEmptyEmbedAliasAllowed} is `false`.
      *
      * If `true`: `[foo.png](foo.png)`.
      *
      * If `false`: `[foo](foo.png)`.
+     *
+     * @default `false`
      */
     readonly shouldIncludeAttachmentExtensionToEmbedAlias?: boolean;
     /**
-     * Indicates if the link should use angle brackets. Defaults to `false`.
+     * Indicates if the link should use angle brackets.
      *
      * Applicable only if {@link linkStyle} is {@link LinkStyle.Markdown}.
      *
      * If `true`: `[alias](<path with spaces.md>)`.
      *
      * If `false`: `[alias](path%20with%20spaces.md)`.
+     *
+     * @default `false`
      */
     readonly shouldUseAngleBrackets?: boolean;
     /**
-     * Indicates if the link should use a leading dot. Defaults to `false`.
+     * Indicates if the link should use a leading dot.
      *
      * Applicable only if {@link linkPathStyle} is {@link LinkPathStyle.RelativePathToSource}.
      *
      * If `true`: `[[./relative/path/to/target]]`
      *
      * If `false`: `[[relative/path/to/target]]`
+     *
+     * @default `false`
      */
     readonly shouldUseLeadingDotForRelativePaths?: boolean;
     /**
-     * Indicates if the link should use a leading slash. Defaults to `false`.
+     * Indicates if the link should use a leading slash.
      *
      * Applicable only if {@link linkPathStyle} is {@link LinkPathStyle.AbsolutePathInVault}.
      *
      * If `true`: `[[/absolute/path/to/target]]`
      *
      * If `false`: `[[absolute/path/to/target]]`
+     *
+     * @default `false`
      */
     readonly shouldUseLeadingSlashForAbsolutePaths?: boolean;
     /**
@@ -233,6 +329,7 @@ export interface GenerateMarkdownLinkParams {
      * @example `[[link-with-empty-subpath]]`
      * @example `[[link-with-subpath#subpath]]`
      * @example `[[link-with-subpath#subpath#nested-subpath]]`
+     * @default `''`
      */
     readonly subpath?: string;
     /**
@@ -249,7 +346,9 @@ export interface GenerateRawMarkdownLinkParams {
      */
     readonly alias?: string | undefined;
     /**
-     * Whether the link should be an embed link. Defaults to `false`.
+     * Whether the link should be an embed link.
+     *
+     * @default `false`
      */
     readonly isEmbed?: boolean;
     /**
@@ -257,11 +356,15 @@ export interface GenerateRawMarkdownLinkParams {
      */
     readonly isWikilink: boolean;
     /**
-     * Whether to escape the alias. Applicable only if {@link isWikilink} is `false`. Defaults to `false`.
+     * Whether to escape the alias. Applicable only if {@link isWikilink} is `false`.
+     *
+     * @default `false`
      */
     readonly shouldEscapeAlias?: boolean;
     /**
-     * Whether to use angle brackets. Applicable only if {@link isWikilink} is `false`. Defaults to `false`.
+     * Whether to use angle brackets. Applicable only if {@link isWikilink} is `false`.
+     *
+     * @default `false`
      */
     readonly shouldUseAngleBrackets?: boolean;
     /**
@@ -459,7 +562,9 @@ export interface UpdateLinkParams {
      */
     readonly oldTargetPathOrFile?: PathOrFile;
     /**
-     * Whether to update file name alias. Defaults to `true`.
+     * Whether to update file name alias.
+     *
+     * @default `true`
      */
     readonly shouldUpdateFileNameAlias?: boolean;
 }
@@ -488,7 +593,9 @@ export interface UpdateLinksInFileParams extends ProcessOptions {
      */
     readonly shouldUpdateEmbedOnlyLinks?: boolean;
     /**
-     * Whether to update file name alias. Defaults to `true`.
+     * Whether to update file name alias.
+     *
+     * @default `true`
      */
     readonly shouldUpdateFileNameAlias?: boolean;
 }
@@ -522,6 +629,8 @@ interface UpdateLinksInContentParams {
     readonly shouldUpdateEmbedOnlyLinks?: boolean;
     /**
      * Whether to update file name alias.
+     *
+     * @default `true`
      */
     readonly shouldUpdateFileNameAlias?: boolean;
 }
@@ -535,33 +644,24 @@ export declare function convertLink(params: ConvertLinkParams): string;
 /**
  * Edits the backlinks for a file or path.
  *
- * @param app - The Obsidian application instance.
- * @param pathOrFile - The path or file to edit the backlinks for.
- * @param linkConverter - The function that converts each link.
- * @param options - Optional options for retrying the operation.
+ * @param params - The parameters for editing the backlinks.
  * @returns A {@link Promise} that resolves when the backlinks have been edited.
  */
-export declare function editBacklinks(app: App, pathOrFile: PathOrFile, linkConverter: (link: Reference) => Promisable<MaybeReturn<string>>, options?: EditBacklinksOptions): Promise<void>;
+export declare function editBacklinks(params: EditBacklinksParams): Promise<void>;
 /**
  * Edits the links for a file or path.
  *
- * @param app - The Obsidian application instance.
- * @param pathOrFile - The path or file to edit the links for.
- * @param linkConverter - The function that converts each link.
- * @param options - Optional options for retrying the operation.
+ * @param params - The parameters for editing the links.
  * @returns A {@link Promise} that resolves when the links have been edited.
  */
-export declare function editLinks(app: App, pathOrFile: PathOrFile, linkConverter: (link: Reference) => Promisable<MaybeReturn<string>>, options?: EditLinksOptions): Promise<void>;
+export declare function editLinks(params: EditLinksParams): Promise<void>;
 /**
  * Edits the links in a content string.
  *
- * @param app - The Obsidian application instance.
- * @param content - The content to edit the links in.
- * @param linkConverter - The function that converts each link.
- * @param abortSignal - The abort signal to control the execution of the function.
+ * @param params - The parameters for editing the links in the content.
  * @returns The promise that resolves to the updated content.
  */
-export declare function editLinksInContent(app: App, content: string, linkConverter: (link: Reference) => Promisable<MaybeReturn<string>>, abortSignal?: AbortSignal): Promise<string>;
+export declare function editLinksInContent(params: EditLinksInContentParams): Promise<string>;
 /**
  * Encodes a URL.
  *
@@ -584,13 +684,10 @@ export declare function escapeAlias(alias: string): string;
 /**
  * Extracts the file associated with a link.
  *
- * @param app - The Obsidian application instance.
- * @param link - The reference cache for the link.
- * @param sourcePathOrFile - The source path or file.
- * @param shouldAllowNonExistingFile - Whether to allow non-existing files. Defaults to `false`.
+ * @param params - The parameters for extracting the link file.
  * @returns The file associated with the link, or `null` if not found.
  */
-export declare function extractLinkFile(app: App, link: Reference, sourcePathOrFile: PathOrFile, shouldAllowNonExistingFile?: boolean): null | TFile;
+export declare function extractLinkFile(params: ExtractLinkFileParams): null | TFile;
 /**
  * Fixes the frontmatter markdown links in the provided metadata cache.
  *