Synclets logoSynclets

createFileDataConnector

The createFileDataConnector function creates a DataConnector that persists Atom data in a single JSON file on the file system.

createFileDataConnector<Depth>(options: FileDataConnectorOptions<Depth>): FileDataConnector<Depth>
TypeDescription
optionsFileDataConnectorOptions<Depth>
returnsFileDataConnector<Depth>

The entire data tree is stored as a JSON object in the specified file. The file is read on initialization and written atomically after each change, making it suitable for small to medium-sized datasets where the entire tree fits comfortably in memory.

This connector is designed for Node.js environments and requires file system access. It will not work in browsers.

Since

v0.0.0