File and Directory Entries API support in Firefox

Non-standard
This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

Draft
This page is not complete.

The original File System API was created to let browsers implement support for accessing a sandboxed virtual file system on the user's storage device. Work to standardize the specification was abandoned back in 2012, but by that point, Google Chrome included its own implementation of the API. Over time, a number of popular sites and Web applications came to use it, often without providing any means of falling back to standard APIs or even checking to be sure the API is available before using it. Mozilla instead opted to implement other APIs which can be used to solve many of the same problems, such as IndexedDB; see the blog post Why no FileSystem API in Firefox? for more insights.

This has caused a number of popular web sites not to work properly on browsers other than Chrome. Because of that, an attempt was made to create a spec offering the features of Google's API which consensus could be reached on. The result was the File and Directory Entries API. This subset of the API provided by Chrome is still not fully specified; however, for web compatibility reasons, it was decided to implement a subset of the API in Firefox; this was introduced in Firefox 50.

This article describes how the Firefox implementation of the File and Directory Entries API differs from other implementations and/or the specification.

Chrome deviations from the specification

The largest compatibility issue still remaining is that Chrome is still using older names for many of the interfaces in the API:

Name in specification Name in Google Chrome
FileSystemDirectoryEntry() DirectoryEntry()
FileSystemDirectoryEntrySync() DirectoryEntrySync()
FileSystemDirectoryReader() DirectoryReader()
FileSystemDirectoryReaderSync() DirectoryReaderSync()
FileSystemEntry() Entry()
FileSystemEntrySync() EntrySync()
FileSystemFileEntry() FileEntry()
FileSystemFileEntrySync() FileEntrySync()

Be sure to account for this in your code by allowing for both names; for example, to ensure your code will work in both Chrome and other browsers, you can include code similar to the following:

var FileSystemDirectoryEntry = window.FileSystemDirectoryEntry || window.DirectoryEntry;
var FileSystemEntry = window.FileSystemEntry || window.Entry;

Limitations in Firefox

Next, let's look at limitations of the Firefox implementation of the API. In broad strokes, those limitations can be summarized as follows:

  • Content scripts can't create file systems or initiate access to a file system. There are only two ways to get access to file system entries at this time:
  • Only the asynchronous versions of the interfaces are implemented. Any interfaces with names that end in "Sync" aren't available.
  • Firefox only supports reading from files in the file system. You can't write to them. In particular, the FileSystemFileEntry.createWriter() method, used to create a FileWriter to handle writing to a file, is not implemented and will just treturn an error.
  • Firefox doesn't support the "filesystem:" URL scheme.

License

© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/file_and_directory_entries_api/firefox_support