FileSystemEntry: getMetadata() method

Deprecated

Avoid using this feature in new projects. This feature may be a candidate for removal from web standards or browsers.

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

js
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.

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

Browser compatibility

See also