FileSystemEntry: getMetadata() method

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.

Non-standard: This feature is not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.

The FileSystemEntry interface's method getMetadata() obtains a Metadata object with information about the file system entry, such as its modification date and time and its size.

Syntax

getMetadata(successCallback)
getMetadata(successCallback, errorCallback)

Parameters

successCallback: A function which is called when the copy operation is successfully completed. Receives a single input parameter: a Metadata object with information about the file.
errorCallback Optional: An optional callback which is executed if an error occurs while looking up the metadata. There's a single parameter: a DOMException describing what went wrong.

Return value

None (undefined).

Exceptions

DOMException.NOT_FOUND_ERR: The FileSystemEntry refers to an item which doesn't exist.
DOMException.SECURITY_ERR: Security restrictions prohibit obtaining the requested metadata.

Examples

This example checks the size of a log file in a temporary folder and, if it exceeds a megabyte, moves it into a different directory.

workingDirectory.getFile(
  "tmp/log.txt",
  {},
  (fileEntry) => {
    fileEntry.getMetadata((metadata) => {
      if (metadata.size > 1048576) {
        workingDirectory.getDirectory(
          "log",
          {},
          (dirEntry) => {
            fileEntry.moveTo(dirEntry);
          },
          handleError,
        );
      }
    });
  },
  handleError,
);

Browser compatibility

	desktop					mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on iOS	Samsung Internet	WebView Android	WebView on iOS
`getMetadata` Deprecated Non-standard	Chrome – Full support Chrome 8 (Release date: 2010-12-02) footnote Full support	Edge – Full support Edge 79 (Release date: 2020-01-15) footnote Full support	Firefox – No support Firefox footnote No support	Opera – Full support Opera 15 (Release date: 2013-07-02) footnote Full support	Safari – No support Safari footnote No support	Chrome Android – Full support Chrome Android 18 (Release date: 2012-06-27) footnote Full support	Firefox for Android – No support Firefox for Android footnote No support	Opera Android – Full support Opera Android 14 (Release date: 2013-05-21) footnote Full support	Safari on iOS – No support Safari on iOS footnote No support	Samsung Internet – Full support Samsung Internet 1 (Release date: 2013-04-27) footnote Full support	WebView Android – Full support WebView Android 4.4 (Release date: 2013-12-09) footnote Full support	WebView on iOS – No support WebView on iOS footnote No support

Tip: you can click/tap on a cell for more information.

Full support: Full support
No support: No support
: Non-standard. Check cross-browser support before using.
: Deprecated. Not for use in new websites.