Interface SyncAction

A single executable sync action produced by the policy engine.

interface SyncAction {
    relativePath: string;
    size: number;
    type: SyncActionType;
    execute(dryRun: boolean): Promise<SyncEvent>;
}

Implemented by

Index

Properties

relativePath size type

Methods

Properties

`Readonly`relativePath

relativePath: string

Relative path of the file this action targets.

`Readonly`size

size: number

Size in bytes of the file, or 0 for metadata-only actions.

`Readonly`type

type: SyncActionType

The kind of action.

Methods

execute

execute(dryRun: boolean): Promise<SyncEvent>
Executes the action (or no-ops if dryRun is true) and returns a corresponding event.
Parameters
- dryRun: boolean
  When true, skip the actual I/O but still return the event.
Returns Promise<SyncEvent>
- Defined in sync/actions/index.ts:25