Class DownloadAction

constructor

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

  Creates a new DownloadAction for the given relative path.

  Parameters

  • relativePath: string

    Path relative to the sync root.

  • size: number

    File size in bytes.

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

    Callback that performs the actual download.

  Returns DownloadAction

ReadonlyrelativePath

Readonlysize

Readonlytype

execute

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

  Downloads the file (unless dryRun) and returns a 'download-done' event.

  Parameters

  • dryRun: boolean

    Whether to simulate the action without making changes.

  • Optionalsignal: AbortSignal

    Optional abort signal for canceling the download.

  Returns Promise<SyncEvent>

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