FileSystemEntry: remove() method

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

Non-standard: This feature is not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.

The FileSystemEntry interface's method remove() deletes the file or directory from the file system. Directories must be empty before they can be removed.

To recursively remove a directory as well as all of its contents and its subdirectories, call FileSystemDirectoryEntry.removeRecursively() instead.

Syntax

js
remove(successCallback)
remove(successCallback, errorCallback)

Parameters

successCallback

A function which is called once the file has been successfully removed.

errorCallback Optional

An optional callback which is called if the attempt to remove the file fails.

Return value

None (undefined).

Exceptions

DOMException.INVALID_MODIFICATION_ERR

The specified entry was the file system's root directory, or the specified entry is a directory which isn't empty.

DOMException.INVALID_STATE_ERR

The file system's cached state is inconsistent with its state on disk, so the file could not be deleted for safety reasons.

DOMException.NO_MODIFICATION_ALLOWED_ERR

The file system's state doesn't permit removing the file or directory.

DOMException.NOT_FOUND_ERR

The file or directory doesn't exist.

DOMException.SECURITY_ERR

The entry couldn't be removed due to permissions or other access constraints, or because there are too many calls being made on file resources.

Examples

This example deletes a temporary work file.

js
workingDirectory.getFile(
  "tmp/work-file.json",
  {},
  (fileEntry) => {
    fileEntry.remove(() => {
      /* the file was removed successfully */
    });
  },
  handleError,
);

Browser compatibility

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
remove
Deprecated Non-standard
Chrome – Full support
Chrome 8 (Release date: 2010-12-02)
footnote Full support
Edge – Full support
Edge 79 (Release date: 2020-01-15)
footnote Full support
Firefox – No support
Firefox
footnote No support
Opera – Full support
Opera 15 (Release date: 2013-07-02)
footnote Full support
Safari – No support
Safari
footnote No support
Chrome Android – Full support
Chrome Android 18 (Release date: 2012-06-27)
footnote Full support
Firefox for Android – No support
Firefox for Android
footnote No support
Opera Android – Full support
Opera Android 14 (Release date: 2013-05-21)
footnote Full support
Safari on iOS – No support
Safari on iOS
footnote No support
Samsung Internet – Full support
Samsung Internet 1 (Release date: 2013-04-27)
footnote Full support
WebView Android – Full support
WebView Android 4.4 (Release date: 2013-12-09)
footnote Full support
WebView on iOS – No support
WebView on iOS
footnote No support

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
Non-standard. Check cross-browser support before using.
Deprecated. Not for use in new websites.

See also