Baseline 2023
Newly available
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Note: This feature is available in Web Workers.
The getDirectory()
method of the StorageManager
interface is used to obtain a reference to a FileSystemDirectoryHandle
object allowing access to a directory and its contents, stored in the origin private file system (OPFS).
None.
Return valueA Promise
that fulfills with a FileSystemDirectoryHandle
object.
SecurityError
DOMException
Thrown if the browser is not able to map the requested directory to the local OPFS, for example due to storage or memory constraints. Also thrown in some browsers if getDirectory()
is called in private browsing mode.
UnknownError
DOMException
Thrown in some browsers if getDirectory()
is called in private browsing mode.
The following asynchronous event handler function is contained inside a Web Worker. On receiving a message from the main thread it:
FileSystemDirectoryHandle
representing the root of the OPFS using getDirectory()
, storing it in the root
variable.FileSystemDirectoryHandle.getFileHandle()
.FileSystemFileHandle.createSyncAccessHandle()
.ArrayBuffer
to contain it.onmessage = async (e) => {
// Retrieve message sent to work from main script
const message = e.data;
// Get handle to draft file
const root = await navigator.storage.getDirectory();
const draftHandle = await root.getFileHandle("draft.txt", { create: true });
// Get sync access handle
const accessHandle = await draftHandle.createSyncAccessHandle();
// Get size of the file.
const fileSize = accessHandle.getSize();
// Read file content to a buffer.
const buffer = new DataView(new ArrayBuffer(fileSize));
const readBuffer = accessHandle.read(buffer, { at: 0 });
// Write the message to the end of the file.
const encoder = new TextEncoder();
const encodedMessage = encoder.encode(message);
const writeBuffer = accessHandle.write(encodedMessage, { at: readBuffer });
// Persist changes to disk.
accessHandle.flush();
// Always close FileSystemSyncAccessHandle if done.
accessHandle.close();
};
Note: In earlier versions of the spec, close()
, flush()
, getSize()
, and truncate()
were wrongly specified as asynchronous methods, and older versions of some browsers implement them in this way. However, all current browsers that support these methods implement them as synchronous methods.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4