FileSystemDirectoryHandle: getFileHandle() method
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{securecontext_header}}{{APIRef("File System API")}}{{AvailableInWorkers}}
The **getFileHandle()** method of the {{domxref("FileSystemDirectoryHandle")}} interface returns a {{domxref('FileSystemFileHandle')}} for a file with the specified name, within the directory the method is called.
Syntax
getFileHandle(name)
getFileHandle(name, options)Parameters
name- : A string representing the {{domxref('FileSystemHandle.name')}} of
the file you wish to retrieve.
options{{optional_inline}}- : An object with the following properties:
create{{optional_inline}}- : A {{jsxref('Boolean')}}. Default
false. When
set to true if the file is not found, one with the specified name will be created and returned.
Return value
A {{jsxref('Promise')}} which resolves with a {{domxref('FileSystemFileHandle')}}.
Exceptions
NotAllowedError{{domxref("DOMException")}}- : Thrown if the {{domxref('PermissionStatus.state')}} for the handle is not
'granted'inreadwritemode if thecreateoption is set totrueor inreadmode if thecreateoption is set tofalse. - {{jsxref("TypeError")}}
- : Thrown if the name specified is not a valid string or contains characters that would
interfere with the native file system.
TypeMismatchError{{domxref("DOMException")}}- : Thrown if the named entry is a directory and not a file.
NotFoundError{{domxref("DOMException")}}- : Thrown if the current entry is not found or if the file doesn't exist and the
createoption is set to
false.
Examples
The following example returns a file handle with the specified name, if the file does not exist it is created.
const fileName = "fileToGetName";
// assuming we have a directory handle: 'currentDirHandle'
const fileHandle = await currentDirHandle.getFileHandle(fileName, {
create: true,
});Specifications
{{Specifications}}
Browser compatibility
{{Compat}}
See also
- File System API
- The File System Access API: simplifying access to local files