Class DeleteLocalAction

constructor

• new DeleteLocalAction(
      relativePath: string,
      absolutePath: string,
      doDelete: (absolutePath: string) => Promise<void>,
  ): DeleteLocalAction

  Creates a new DeleteLocalAction for the given relative path.

  Parameters

  • relativePath: string

    Path relative to the sync root.

  • absolutePath: string

    Absolute local filesystem path.

  • doDelete: (absolutePath: string) => Promise<void>

    Callback that performs the deletion.

  Returns DeleteLocalAction

ReadonlyabsolutePath

ReadonlyrelativePath

Readonlysize

Readonlytype

execute

• execute(dryRun: boolean): Promise<SyncEvent>

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

  Parameters

  • dryRun: boolean

    Whether to simulate the action without making changes.

  Returns Promise<SyncEvent>

  An async generator yielding sync progress events.