CreateSyncPlanOptions

Defined in: src/sync/createSyncPlan.ts:48

Options accepted by createSyncPlan.

Properties

Property	Type	Description	Defined in
conflictPolicy?	SyncConflictPolicy	Conflict policy. Defaults to "overwrite".	src/sync/createSyncPlan.ts:62
deletePolicy?	SyncDeletePolicy	Delete policy. Defaults to "never".	src/sync/createSyncPlan.ts:60
destination	SyncEndpointInput	Destination-side endpoint that produced the diff.	src/sync/createSyncPlan.ts:56
diff	RemoteTreeDiff	Diff produced by diffRemoteTrees or an equivalent source.	src/sync/createSyncPlan.ts:52
direction?	SyncDirection	Sync direction. Defaults to "source-to-destination".	src/sync/createSyncPlan.ts:58
dryRun?	boolean	Whether the plan is informational only. Defaults to true.	src/sync/createSyncPlan.ts:66
id	string	Stable plan identifier.	src/sync/createSyncPlan.ts:50
includeDirectoryActions?	boolean	Whether to plan upload/download steps for directories. Defaults to false.	src/sync/createSyncPlan.ts:64
metadata?	Record<string, unknown>	Caller-defined metadata retained for diagnostics.	src/sync/createSyncPlan.ts:70
now?	() => Date	Clock used for deterministic tests. Defaults to new Date().	src/sync/createSyncPlan.ts:68
source	SyncEndpointInput	Source-side endpoint that produced the diff.	src/sync/createSyncPlan.ts:54