feat(API): ✨ Add refreshIndex method (#369)

SkepticMystic · Apr 17, 2022 · f9b97b9 · f9b97b9
1 parent 42b2b67
commit f9b97b9
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 7 deletions.
diff --git a/src/API.ts b/src/API.ts
@@ -18,6 +18,7 @@ import {
   iterateHiers,
 } from "./Utils/HierUtils";
 import { createIndex } from "./Commands/CreateIndex";
+import { refreshIndex } from "./refreshIndex";
 
 export class BCAPI implements BCAPII {
   app: App;
@@ -37,6 +38,8 @@ export class BCAPI implements BCAPII {
 
   public buildObsGraph = () => buildObsGraph(this.app);
 
+  public refreshIndex = async () => await refreshIndex(this.plugin)
+
   public getSubInDirs = (dirs: Directions[], g = this.mainG) =>
     getSubInDirs(g, ...dirs);
 

diff --git a/src/interfaces.ts b/src/interfaces.ts
@@ -133,13 +133,13 @@ export type RawValue =
 export interface dvFrontmatterCache {
   file: TFile;
   [field: string]:
-    | string
-    | string[]
-    | string[][]
-    | dvLink
-    | dvLink[]
-    | Pos
-    | TFile;
+  | string
+  | string[]
+  | string[][]
+  | dvLink
+  | dvLink[]
+  | Pos
+  | TFile;
 }
 
 export type Directions = typeof DIRECTIONS[number];
@@ -352,6 +352,9 @@ export interface BCAPII {
   /** Build the obsidian graph as a graphology MultiGraph */
   buildObsGraph: () => MultiGraph;
 
+  /** Refresh the Breadcrumb Index programmatically. */
+  refreshIndex: () => Promise<void>
+
   /**
    * Return a subgraph of all nodes & edges with `dirs.includes(a.dir)`
    *