FileSystemEntry: remove() method

Deprecated

Avoid using this feature in new projects. This feature may be a candidate for removal from web standards or browsers.

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

See also