Skip to content

DataStoreTransportConstructorParams

Parameters for the shared-store vault transport.

Import:

import type { DataStoreTransportConstructorParams } from '@mnaoumov/obsidian-lib/data-stores/data-store-transport';

Signature:

export interface DataStoreTransportConstructorParams

Properties

PropertyTypeDescription
adapterDataAdapterVault adapter; no desktop filesystem APIs are used.
folder?stringVault-relative folder. Hidden segments are allowed; callers must arrange their synchronization.
format?'json' | 'markdown'Document encoding. JSON requires a sync tool configured to carry arbitrary files.
maxFileBytes?numberMaximum UTF-8 bytes in any file, including its encoding wrapper.
maxSnapshotBytes?numberMaximum UTF-8 bytes in the reconstructed snapshot, before JSON parsing.
pluginIdstringPlugin manifest id.
storeIdstringStore name including its consumer schema version.