Synclets logoSynclets

createDirectoryDataConnector

The createDirectoryDataConnector function creates a DataConnector that persists Atom data across multiple individual files within a directory.

createDirectoryDataConnector<Depth>(options: DirectoryDataConnectorOptions<Depth>): DirectoryDataConnector<Depth>
TypeDescription
optionsDirectoryDataConnectorOptions<Depth>
returnsDirectoryDataConnector<Depth>

Each leaf address in the data tree is stored as a separate file, with the file path reflecting the address hierarchy. This approach is more scalable than file-based storage for large datasets, as only modified values need to be read or written rather than the entire tree.

The directory structure is created automatically. This connector is designed for Node.js environments and requires file system access.

Since

v0.0.0