downloads.removeFile()

TheremoveFile() function of thedownloads 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 todownloads.search() will still return the item as aDownloadItem, but itsexists attribute will befalse.

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

This is an asynchronous function that returns aPromise.

Note:If you want to remove a downloaded file from diskand erase it from history, you have to callremoveFile() before you calldownloads.erase(). If you try it the other way around you'll get an error when callingremoveFile(), because the browser will no longer have a record of the download.

Syntax

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

Parameters

downloadId: Aninteger representing the id of theDownloadItem you want to delete from disk.

Return value

APromise. 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.

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) {    let removing = browser.downloads.removeFile(downloadItems[0].id);    removing.then(onRemoved, onError);  }}let searching = browser.downloads.search({  limit: 1,  orderBy: ["-startTime"],});searching.then(remove, onError);