Skip to content

SharedDataStoreOpenParams

Parameters for opening a shared store.

Import:

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

Signature:

export interface SharedDataStoreOpenParams

Properties

PropertyTypeDescription
activeDeviceMilliseconds?numberDevice retirement interval, measured from its last acknowledgement.
adapterDataAdapterVault adapter.
folder?stringVault-relative folder. Hidden segments are allowed; callers must arrange their synchronization.
format?'json' | 'markdown'New document encoding at the permanent discovery anchor.
isSyncEnabled?booleanEnables vault transport. Disabled stores make no adapter calls, including during compaction.
kindDataStoreMergeKindImmutable merge rule; changing it requires a new store id.
localLocalDataStoreDedicated local store scoped to THIS vault, plugin and shared-store schema. The caller owns its connection.
maxFileBytes?numberMaximum UTF-8 bytes per file, wrapper included.
maxSnapshotBytes?numberMaximum UTF-8 bytes in a reconstructed snapshot before JSON parsing.
pluginIdstringPlugin manifest id.
storeIdstringStore id including the consumer's schema version.