File and Directory Entries API

このロケールの翻訳が存在しないため、英語バージョンのコンテンツを表示しています。 Help us translate this article!

非標準
この機能は標準ではなく、標準化の予定もありません。公開されているウェブサイトには使用しないでください。ユーザーによっては使用できないことがあります。実装ごとに大きな差があることもあり、将来は振る舞いが変わるかもしれません。

The File and Directory Entries API simulates a local file system that web apps can navigate within and access files in. You can develop apps which read, write, and create files and/or directories in a virtual, sandboxed file system.

Because this is a non-standard API, whose specification is not currently on a standards track, it's important to keep in mind that not all browsers implement it, and those that do may implement only small portions of it. Check the Browser compatibility section for details.

Two very similar APIs exist depending on whether you desire asynchronous or synchronous behavior. The synchronous API is indended to be used inside a Worker and will return the values you desire. The asynchronous API will not block and functions and the API will not return values; instead, you will need to supply a callback function to handle the response whenever it arrives.

The Firefox implementation of the File and Directory Entries API is very limited; there is no support for creating files. Only for accessing files which are selected by the user in a file <input> element (see HTMLInputElement as well) or when a file or directory is provided to the Web site or app using drag and drop. Firefox also does not implement the synchronous API. Check the browser compatibility for any part of the API you use carefully, and see File and Directory Entries API support in Firefox for more details.

Getting access to a file system

There are two ways to get access to file systems defined in the current specification draft:

When handling a drop event for drag and drop, you can call DataTransferItem.webkitGetAsEntry() to get the FileSystemEntry for a dropped item. If the result isn't null, then it's a dropped file or directory, and you can use file system calls to work with it.
The HTMLInputElement.webkitEntries property lets you access the FileSystemFileEntry objects for the currently selected files, but only if they are dragged-and-dropped onto the file chooser (バグ 1326031). If HTMLInputElement.webkitdirectory is true, the <input> element is instead a directory picker, and you get FileSystemDirectoryEntry objects for each selected directory.

Asynchronous API

The asynchronous API should be used for most operations, to prevent file system accesses from blocking the entire browser if used on the main thread. It includes the following interfaces:

FileSystem: Represents a file system.
FileSystemEntry: The basic interface representing a single entry in a file system. This is implemented by other interfaces which represent files or directories.
FileSystemFileEntry: Represents a single file in a file system.
FileSystemDirectoryEntry: Represents a single directory in a file system.
FileSystemDirectoryReader: Created by calling FileSystemDirectoryEntry.createReader(), this interface provides the functionality which lets you read the contents of a directory.
FileSystemFlags: Defines a set of values which are used when specifying option flags when calling certain methods in the File and Directory Entries API.
FileError: Represents an error which is generated by asynchronous file system calls.

There are also two global functions (which are not part of the specification at this time and are implemented only by Google Chrome). They're available on the Window object and implemented in LocalFileSystem: requestFileSystem() and resolveLocalFileSystemURL().

Synchronous API

The synchronous API is should only be used in Workers; these calls block until they're finished executing, and simply return the results instead of using callbacks. Using them on the main thread will block the browser, which is naughty. The interfaces below otherwise mirror the ones from the asynchronous API.

FileSystemSync: Represents a file system.
FileSystemEntrySync: The basic interface representing a single entry in a file system. This is implemented by other interfaces which represent files or directories.
FileSystemFileEntrySync: Represents a single file in a file system.
FileSystemDirectoryEntrySync: Represents a single directory in a file system.
FileSystemDirectoryReaderSync: Created by calling FileSystemDirectoryEntrySync.createReader(), this interface provides the functionality which lets you read the contents of a directory.
FileException: Represents an error which is generated by synchronous file system calls.

There are also two global functions (which are not part of the specification at this time and are implemented only by Google Chrome). They're available on the Worker object and implemented in LocalFileSystemSync: requestFileSystemSync() and resolveLocalFileSystemSyncURL().

Other Interfaces

LocalFileSystem: Gives you access to a sandboxed file system.
LocalFileSystemSync

LockedFile: Provides tools to deal with a given file with all the necessary locks.
Metadata

Specifications

Specification	Status	Comment
File and Directory Entries API	ドラフト	Draft of proposed API

This API has no official W3C or WHATWG specification.

Browser compatibility

`FileSystem`

Update compatibility data on GitHub

	デスクトップ						モバイル
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Android 版 Chrome	Android 版 Firefox	Android 版 Opera	iOSのSafari	Samsung Internet
`FileSystem` 非推奨非標準	Chrome 完全対応 13 接頭辞付き完全対応 13 接頭辞付き接頭辞付き webkit のベンダー接頭辞が必要	Edge 完全対応あり接頭辞付き補足完全対応あり接頭辞付き補足接頭辞付き WebKit のベンダー接頭辞が必要補足 Edge only supports this API in drag-and-drop scenarios using the the `DataTransferItem.webkitGetAsEntry()` method. It's not available for use in file or folder picker panels (such as when you use an `<input>` element with the `HTMLInputElement.webkitdirectory` attribute.	Firefox 完全対応 50	IE 未対応なし	Opera 完全対応 15 接頭辞付き完全対応 15 接頭辞付き接頭辞付き webkit のベンダー接頭辞が必要	Safari 未対応なし	WebView Android 完全対応 37 接頭辞付き完全対応 37 接頭辞付き接頭辞付き webkit のベンダー接頭辞が必要	Chrome Android 完全対応 18 接頭辞付き完全対応 18 接頭辞付き接頭辞付き webkit のベンダー接頭辞が必要	Firefox Android 完全対応 50	Opera Android 完全対応 14 接頭辞付き完全対応 14 接頭辞付き接頭辞付き webkit のベンダー接頭辞が必要	Safari iOS 未対応なし	Samsung Internet Android ?

凡例

完全対応: 完全対応
未対応: 未対応
実装状況不明: 実装状況不明
非標準。ブラウザー間の互換性が低い可能性があります。: 非標準。ブラウザー間の互換性が低い可能性があります。
非推奨。新しいウェブサイトでは使用しないでください。: 非推奨。新しいウェブサイトでは使用しないでください。
実装ノートを参照してください。: 実装ノートを参照してください。
使用するには、ベンダー接頭辞または異なる名前が必要です。: 使用するには、ベンダー接頭辞または異なる名前が必要です。

`FileSystemSync` property