SharedDataStoreOpenParams
Parameters for opening a shared store.
Import:
import type { SharedDataStoreOpenParams } from '@mnaoumov/obsidian-lib/data-stores/shared-data-store';Signature:
export interface SharedDataStoreOpenParamsProperties
| Property | Type | Description |
|---|---|---|
| activeDeviceMilliseconds? | number | Device retirement interval, measured from its last acknowledgement. |
| adapter | DataAdapter | Vault adapter. |
| folder? | string | Vault-relative folder. Hidden segments are allowed; callers must arrange their synchronization. |
| format? | 'json' | 'markdown' | New document encoding at the permanent discovery anchor. |
| isSyncEnabled? | boolean | Enables vault transport. Disabled stores make no adapter calls, including during compaction. |
| kind | DataStoreMergeKind | Immutable merge rule; changing it requires a new store id. |
| local | LocalDataStore | Dedicated local store scoped to THIS vault, plugin and shared-store schema. The caller owns its connection. |
| maxFileBytes? | number | Maximum UTF-8 bytes per file, wrapper included. |
| maxSnapshotBytes? | number | Maximum UTF-8 bytes in a reconstructed snapshot before JSON parsing. |
| pluginId | string | Plugin manifest id. |
| storeId | string | Store id including the consumer's schema version. |