Interface PlanOptions

Options of SyncSession.plan.

interface PlanOptions {
    deleteOrphans?: boolean;
    direction: Direction;
    onProgress?: (event: ProgressEvent) => void;
    scope?: Scope;
    signal?: AbortSignal;
}

Index

Properties

deleteOrphans? direction onProgress? scope? signal?

Properties

`Optional` `Readonly`deleteOrphans

deleteOrphans?: boolean

The delete option of the sync dialog.

`Readonly`direction

direction: Direction

Put newer local files, get newer remote files, or both.

`Optional` `Readonly`onProgress

onProgress?: (event: ProgressEvent) => void

Receives scan-local, scan-remote and compare events.

`Optional` `Readonly`scope

scope?: Scope

The whole site, or some paths of it. Default: the whole site.

`Optional` `Readonly`signal

signal?: AbortSignal

Stops the scan; the call then rejects with E_CANCELLED.