Class UploadAction

constructor

• new UploadAction(
      relativePath: string,
      absolutePath: string,
      size: number,
      doUpload: (
          absolutePath: string,
          relativePath: string,
          signal?: AbortSignal,
      ) => Promise<void>,
  ): UploadAction

  Creates a new UploadAction for the given relative path.

  Parameters

  • relativePath: string

    Path relative to the sync root.

  • absolutePath: string

    Absolute local filesystem path.

  • size: number

    File size in bytes.

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

    Callback that performs the actual upload.

  Returns UploadAction

ReadonlyabsolutePath

ReadonlyrelativePath

Readonlysize

Readonlytype

execute

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

  Uploads the file (unless dryRun) and returns an 'upload-done' event.

  Parameters

  • dryRun: boolean

    Whether to simulate the action without making changes.

  • Optionalsignal: AbortSignal

    Optional abort signal for canceling the upload.

  Returns Promise<SyncEvent>

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