DataStoreTransportConstructorParams
Parameters for the shared-store vault transport.
Import:
import type { DataStoreTransportConstructorParams } from '@mnaoumov/obsidian-lib/data-stores/data-store-transport';Signature:
export interface DataStoreTransportConstructorParamsProperties
| Property | Type | Description |
|---|---|---|
| adapter | DataAdapter | Vault adapter; no desktop filesystem APIs are used. |
| folder? | string | Vault-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? | number | Maximum UTF-8 bytes in any file, including its encoding wrapper. |
| maxSnapshotBytes? | number | Maximum UTF-8 bytes in the reconstructed snapshot, before JSON parsing. |
| pluginId | string | Plugin manifest id. |
| storeId | string | Store name including its consumer schema version. |