mozilla

FileHandle

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.

Summary

The FileHandle interface provides access in read or write mode to a file, dealing with all the necessary locks.

As FileHandle objects are bound to a fake file system built on top of IndexedDB, such an object is created using the IDBDatabase.mozCreateFileHandle method.

Properties

FileHandle.name Read only
The name of the handled file.
FileHandle.type Read only
The mime type of the handled file.

Events Handler

FileHandle.onabort
The abort event is triggered each time the handled file is aborted.
FileHandle.onerror
The error event is triggered each time something goes wrong.

Methods

FileHandle.open()
Returns a LockedFile object to read or write the associated file safely.
FileHandle.getFile()
Returns a DOMRequest object. In case of success, the request's result is a File object representing a snapshot of the handled file.

Specifications

Specification Status Comment
FileSystem API Editor's Draft Draft proposal.

See also

Document Tags and Contributors

Contributors to this page: fscholz, Jeremie, kscarfone, pbmj5233
Last updated by: Jeremie,