Skip to content

vaultmd / Vault

Type Alias: Vault

Vault = object

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

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

Properties

io

io: VaultIo

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

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


notes

notes: NotesApi

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

Notes CRUD surface. See NotesApi.


query

query: QueryApi

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

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

Methods

close()

close(): void

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

Close the underlying database.

Returns

void


rebuild()

rebuild(): Promise<void>

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

Drop and rebuild the entire index from disk.

Returns

Promise<void>


reconcile()

reconcile(): Promise<void>

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

Reconcile the whole index with on-disk state.

Returns

Promise<void>


reconcilePaths()

reconcilePaths(rels): Promise<void>

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

Reconcile only the given vault-relative paths.

Parameters

rels

string[]

Returns

Promise<void>