LocalFileSystemSync.requestFileSystemSync()

Experimental

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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.

Draft

This page is not complete.

The requestFileSystemSync method of the LocalFileSystemSync interface of the File System API creates a new a sandboxed file system. It is intended to be used with WebWorkers. The methods are implemented by worker objects.

Warning:

This document was last updated on March 2, 2012 and follows the W3C Specifications (Working Draft) drafted on April 19, 2011.

This specification is more or less abandoned, failing to get significant traction.

Syntax

LocalFileSystemSync.requestFileSystemSync(
  unsigned short type,
  unsigned long long size
);

Parameters

type
The storage type of the file system. The values can be either TEMPORARY or PERSISTENT.
size
The storage space — in bytes — that you need for your app.

Returns

FileSystemSync
An object that represents the file system.

Exceptions

This method can raise an FileException with the following code:

Exception Description
SECURITY_ERROR The application does not have permission to access the file system interface. For example, you cannot run from file://. For more details, see the article on basic concepts.

Examples

//Taking care of the browser-specific prefix
window.requestFileSystemSync  = window.requestFileSystemSync || window.webkitRequestFileSystemSync;

// The first parameter defines the type of storage: persistent or temporary
// Next, set the size of space needed (in bytes)
// initFs is the success callback
// And the last one is the error callback
// for denial of access and other errors.

var fs = requestFileSystemSync(TEMPORARY, 1024*1024 /*1MB*/);

Since this interface is synchronous, it doesn't need success and error callbacks.

Specifications

Specification Status Comment
File API: Directories and System Specification Working Draft Initial specification, abandoned.

Browser compatibility

No compatibility data found for api.LocalFileSystemSync.requestFileSystemSync.
Check for problems with this page or contribute missing data to mdn/browser-compat-data.

See also