FileSystemDirectoryHandle: removeEntry() method
File System API
File System API
The removeEntry() method of the
FileSystemDirectoryHandle interface attempts to remove an entry if the
directory handle contains a file or directory called the name specified.
Syntax
removeEntry(name)
removeEntry(name, options)
Parameters
name- : A string representing the FileSystemHandle.name of the entry you wish to remove.
options- : An optional object containing options, which are as follows:
recursive- : A boolean value, which defaults to
false. When set totrueentries will be removed recursively.
Return value
A Promise which resolves with undefined.
Exceptions
- TypeError
- : Thrown if the name is not a valid string or contains characters not allowed on the file system.
NotAllowedErrorDOMException- : Thrown if the PermissionStatus.state for the handle is not
'granted'inreadwritemode. InvalidModificationErrorDOMException- : Thrown if
recursiveis set to false and the entry to be removed has children. NotFoundErrorDOMException- : Thrown if the current entry is not found or if the entry of the specific name is not found or matched.
Examples
The following example removes an entry within the directory handle.
const entryName = "entryToRemove";
// assuming we have a directory handle: 'currentDirHandle'
currentDirHandle.removeEntry(entryName).then(() => {
// code to run if removing was successful
});