VaultMD

Appearance

VaultMD / Vault

Type Alias: Vault ​

Vault = object

Defined in: src/vault/models/vault.ts:7

A live vault handle: IO surface, notes CRUD, queries, and lifecycle.

Properties ​

io ​

io: VaultIo

Defined in: src/vault/models/vault.ts:9

The path-scoped IO chokepoint (allowlists, canonicalization).

notes ​

notes: NotesApi

Defined in: src/vault/models/vault.ts:11

Notes CRUD surface. See NotesApi.

query ​

query: QueryApi

Defined in: src/vault/models/vault.ts:13

Read-only query surface over the index. See QueryApi.

Methods ​

close() ​

close(): void

Defined in: src/vault/models/vault.ts:25

Close the underlying database.

Returns ​

void

rebuild() ​

rebuild(): Promise<void>

Defined in: src/vault/models/vault.ts:23

Drop and rebuild the entire index from disk.

Returns ​

Promise<void>

reconcile() ​

reconcile(): Promise<ReconcileResult>

Defined in: src/vault/models/vault.ts:19

Reconcile the whole index with on-disk state, and report what changed. Poll this to pick up out-of-band edits: they update the index but never fire onCommit. See ReconcileResult.

Returns ​

Promise<ReconcileResult>

reconcilePaths() ​

reconcilePaths(rels): Promise<void>

Defined in: src/vault/models/vault.ts:21

Reconcile only the given vault-relative paths.

Parameters ​

rels ​

string[]

Returns ​

Promise<void>