Join MDN and developers like you at Mozilla's View Source conference, 12-14 September in Berlin, Germany. Learn more at https://viewsourceconf.org

DeviceStorage.freeSpace()

This article needs a technical review. How you can help.

This API is available on Firefox OS for privileged or certified applications only.

Summary

The freeSpace method is used to get the amount of free space usable by the storage area.

The request's result is a number representing the amount of free space expressed in Bytes.

Syntax

var instanceOfDOMRequest = instanceOfDeviceStorage.freeSpace();

Returns

It returns a DOMRequest object to handle the success or error of the operation.

Example

var sdcard = navigator.getDeviceStorage("sdcard");

var request = sdcard.freeSpace();

request.onsuccess = function () {
  // The result is expressed in bytes, let's turn it into Gigabytes
  var size = this.result / Math.pow(10,9);

  console.log("You have " + size.toFixed(2) + "GB of free space on your SDCard.");
}

request.onerror = function () {
  console.warn("Unable to get the free space available for the SDCard: " + this.error);
}

Specification

Not part of any specification.

See also

Document Tags and Contributors

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