FileEntrySync

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.

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

The FileEntrySync interface represents a file in a file system. It lets you write content to a file.

Warning: This interface is deprecated and is no more on the standard track. Do not use it anymore. Use the File and Directory Entries API instead.

Basic concepts

To write content to file, create a FileWriter object by calling createWriter().

Method overview

FileWriterSync createWriter ());
File file ());

Instance methods

createWriter()

Creates a new FileWriter associated with the file that the FileEntry represents.

js
createWriter()

Parameters

None.

Return value

A FileWriterSync object.

Exceptions

This method can raise a DOMException with the following codes:

Exception Description
NOT_FOUND_ERR The file does not exist.
INVALID_STATE_ERR The file is no longer valid for some reason other than it having been deleted.

file()

Returns a File that represents the current state of the file that this FileEntry represents.

js
file()

Parameters

None.

Return value

A File object.

Exceptions

This method can raise a DOMException with the following codes:

Exception Description
NOT_FOUND_ERR The file does not exist.
INVALID_STATE_ERR The file is no longer valid for some reason other than it having been deleted.

Specifications

This feature is not part of any specification anymore. It is no longer on track to become a standard.

Browser compatibility

BCD tables only load in the browser

See also