Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/earthstar/src/sync-fs/sync-fs-types.ts>SyncFsOptions

Earthstar is a tool for private, undiscoverable, offline-first networks.
earthstar-project/earthstar
Go to Latest
type alias SyncFsOptions
import { type SyncFsOptions } from "https://deno.land/x/earthstar@v10.0.0-alpha.4/src/sync-fs/sync-fs-types.ts";

Options for syncing a replica with a filesystem directory.

  • dirPath: The filesystem path of the directory to be synced
  • replica: The replica to be synced with the directory
  • keypair: The keypair to be used to sign all writes derived from changes on the filesystem.
  • allowDirtyDirWithoutManifest: Whether to allow syncing of a folder with pre-existing contents which has never been synced before.
definition: { dirPath: string; replica: Replica; keypair: AuthorKeypair; allowDirtyDirWithoutManifest: boolean; overwriteFilesAtOwnedPaths?: boolean; }