yanki 2.0.4 → 2.0.5

package/dist/lib/index.d.ts

@@ -82,20 +82,32 @@ type GlobalOptions = {
    * invoke a sync to AnkiWeb. This is the equivalent of pushing the "sync"
    * button in the Anki app.
    */
-  ankiWeb: boolean; /** Override where "/" should resolve to... useful in Obsidian to set the vault path as the "root" */
-  basePath: string | undefined; /** Run Anki's "Check Database" command after sync updates that might produce card corruption */
+  ankiWeb: boolean;
+  /**
+   * Override where "/" should resolve to... useful in Obsidian to set the vault
+   * path as the "root"
+   */
+  basePath: string | undefined;
+  /**
+   * Run Anki's "Check Database" command after sync updates that might produce
+   * card corruption
+   */
   checkDatabase: boolean;
   cwd: string;
   dryRun: boolean;
   /**
    * Exposed for Obsidian, currently only used for getting URL content hashes
-   * and inferring MIME types of URLs without extensions.
-   * Note that ankiConnectOptions ALSO has a fetch adapter option specifically
-   * for communicating with Anki-Connect.
+   * and inferring MIME types of URLs without extensions. Note that
+   * ankiConnectOptions ALSO has a fetch adapter option specifically for
+   * communicating with Anki-Connect.
    */
   fetchAdapter: FetchAdapter | undefined;
   fileAdapter: FileAdapter | undefined;
-  manageFilenames: ManageFilenames; /** Only applies if manageFilenames is `true`. Will _not_ truncate user-specified file names in other cases. */
+  manageFilenames: ManageFilenames;
+  /**
+   * Only applies if manageFilenames is `true`. Will _not_ truncate
+   * user-specified file names in other cases.
+   */
   maxFilenameLength: number;
   namespace: string; /** Ensures that wiki-style links work correctly */
   obsidianVault: string | undefined; /** Exposed for testing only */
@@ -104,7 +116,12 @@ type GlobalOptions = {
    * Whether to treat single newlines in Markdown as line breaks in the
    * resulting HTML (Obsidian has an application-level setting for this)
    */
-  strictLineBreaks: boolean; /** Only consider exact noteId matches between the local and remote copies to be equivalent, don't match local notes with "orphaned" remote notes based on content */
+  strictLineBreaks: boolean;
+  /**
+   * Only consider exact noteId matches between the local and remote copies to
+   * be equivalent, don't match local notes with "orphaned" remote notes based
+   * on content
+   */
   strictMatching: boolean; /** Sync image, video, and audio assets to Anki's media storage system */
   syncMediaAssets: SyncMediaAssets;
 };
@@ -122,8 +139,10 @@ type CleanResult = Simplify<Pick<GlobalOptions, 'ankiWeb' | 'dryRun' | 'namespac
  * Deletes all remote notes in Anki associated with the given namespace.
  *
  * Use with significant caution. Mostly useful for testing.
+ *
  * @returns The IDs of the notes that were deleted
- * @throws {Error} If Anki is unreachable or another error occurs during deletion.
+ * @throws {Error} If Anki is unreachable or another error occurs during
+ *   deletion.
  */
 declare function cleanNotes(options?: PartialDeep<CleanOptions>): Promise<CleanResult>;
 declare function formatCleanResult(result: CleanResult, verbose?: boolean): string;
@@ -152,7 +171,12 @@ type LocalNote = {
 };
 //#endregion
 //#region src/lib/actions/rename.d.ts
-type RenameNotesOptions = Pick<GlobalOptions, 'dryRun' | 'fileAdapter' | 'manageFilenames' | 'maxFilenameLength' /** Included because this can technically change the content of the "first line" of a card */ | 'strictLineBreaks'>;
+type RenameNotesOptions = Pick<GlobalOptions, 'dryRun' | 'fileAdapter' | 'manageFilenames' | 'maxFilenameLength'
+/**
+ * Included because this can technically change the content of the "first
+ * line" of a card
+ */
+| 'strictLineBreaks'>;
 type RenameFilesResult = {
   dryRun: boolean;
   notes: LocalNote[];
@@ -199,9 +223,11 @@ type SyncNotesResult = Simplify<Pick<GlobalOptions, 'ankiWeb' | 'dryRun' | 'name
 }>;
 /**
  * Syncs local notes to Anki.
+ *
  * @param allLocalNotes All the YankiNotes to sync
+ *
  * @returns The synced notes (with new IDs where applicable), plus some stats
- * about the sync
+ *   about the sync
  * @throws {Error} For various reasons...
  */
 declare function syncNotes(allLocalNotes: YankiNote[], options?: PartialDeep<SyncNotesOptions>): Promise<SyncNotesResult>;
@@ -223,9 +249,11 @@ type SyncFilesResult = Simplify<Omit<SyncNotesResult, 'synced'> & {
  *
  * Most importantly, it updates the note IDs in the frontmatter of the local
  * files.
+ *
  * @param allLocalFilePaths Array of paths to the local markdown files
+ *
  * @returns The synced files (with new IDs where applicable), plus some stats
- * about the sync
+ *   about the sync
  * @throws {Error} If syncing fails or file operations encounter an error.
  */
 declare function syncFiles(allLocalFilePaths: string[], options?: PartialDeep<SyncFilesOptions>): Promise<SyncFilesResult>;