Class CopyAction

constructor

• new CopyAction(
      relativePath: string,
      size: number,
      doCopy: (relativePath: string, signal?: AbortSignal) => Promise<void>,
  ): CopyAction

  Creates a new CopyAction for the given relative path.

  Parameters

  • relativePath: string

    Path relative to the sync root.

  • size: number

    File size in bytes.

  • doCopy: (relativePath: string, signal?: AbortSignal) => Promise<void>

    Callback that performs the server-side copy.

  Returns CopyAction

ReadonlyrelativePath

Readonlysize

Readonlytype

execute

• execute(dryRun: boolean, signal?: AbortSignal): Promise<SyncEvent>

  Copies the file (unless dryRun) and returns a 'copy-done' event.

  Parameters

  • dryRun: boolean

    Whether to simulate the action without making changes.

  • Optionalsignal: AbortSignal

    Optional abort signal for canceling the copy.

  Returns Promise<SyncEvent>

  A promise resolving to the sync event produced by the action.