vaultmd

Appearance

vaultmd / createVaultIo

Function: createVaultIo() ​

createVaultIo(config): VaultIo

Defined in: src/vault-io/create-vault-io.ts:42

Create a VaultIo instance scoped to config.root and the supplied prefix allowlists. The returned handle is the single IO chokepoint for all file reads, writes, and enumerations; it enforces path canonicalization, allowlist membership, symlink guards, and case-sensitivity probing.

Parameters ​

config ​

VaultIoConfig

IO configuration — at minimum root and prefixes.

Returns ​

VaultIo

A ready-to-use VaultIo handle.

Example ​

ts
const io = createVaultIo({
  root: '/notes',
  prefixes: { read: [''], write: ['drafts'] },
});
const file = await io.readVaultFile('drafts/idea.md');