downloads.removeFile()

The removeFile() function of the downloads API removes a downloaded file from disk.

This API removes the file from disk, but does not remove it from the browser's downloads history, therefore a call to downloads.search() will still return the item as a DownloadItem, but its exists attribute will be false.

To remove a file from the downloads history, you need to use downloads.erase().

This is an asynchronous function that returns a Promise.

Syntax

var removing = browser.downloads.removeFile(
  downloadId      // integer
)

Parameters

downloadId

An integer representing the id of the DownloadItem you want to delete from disk.

Return value

A Promise. If the request was successful, the promise will be fulfilled with no arguments. If the request failed, the promise will be rejected with an error message.

Browser compatibility

Examples

Remove the most recently downloaded file:

function onRemoved() {
  console.log(`Removed item`);
}

function onError(error) {
  console.log(`Error: ${error}`);
}

function remove(downloadItems) {
  if (downloadItems.length > 0) {
    var removing = browser.downloads.removeFile(downloadItems[0].id);
    removing.then(onRemoved, onError);
  }
}

var searching = browser.downloads.search({
  limit: 1,
  orderBy: ["-startTime"]
});

searching.then(remove, onError);

Example extensions

• latest-download