Class DeleteRemoteAction

constructor

• new DeleteRemoteAction(
      relativePath: string,
      fileId: string,
      doDelete: (
          fileId: string,
          fileName: string,
          signal?: AbortSignal,
      ) => Promise<void>,
  ): DeleteRemoteAction

  Creates a new DeleteRemoteAction for the given relative path.

  Parameters

  • relativePath: string

    Path relative to the sync root.

  • fileId: string

    The B2 file version ID to delete.

  • doDelete: (fileId: string, fileName: string, signal?: AbortSignal) => Promise<void>

    Callback that performs the deletion.

  Returns DeleteRemoteAction

ReadonlyfileId

ReadonlyrelativePath

Readonlysize

Readonlytype

execute

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

  Deletes the remote file version (unless dryRun) and returns a 'delete-remote' event.

  Parameters

  • dryRun: boolean

    Whether to simulate the action without making changes.

  • Optionalsignal: AbortSignal

    Optional abort signal for canceling the delete request.

  Returns Promise<SyncEvent>

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