This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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.
The create property on the FileSystemFlags dictionary is used to indicate whether or not the file should be created if it's missing. FileSystemFlags is only used when calling FileSystemDirectoryEntry.getFile() or FileSystemDirectoryEntry.getDirectory().
Syntax
fileSystemFlags.create = booleanValue
Values
The table below describes the result of each possible combination of these flags depending on whether or not the target file or directory path already exists.
| Option values | File/directory condition | Result | ||
|---|---|---|---|---|
create |
exclusive |
|||
false |
n/a[1] | Path exists and matches the desired type (depending on whether the function called is getFile() or getDirectory() |
The successCallback is called with a FileSystemFileEntry if getFile() was called or a FileSystemDirectoryEntry if getDirectory() was called. |
|
false |
n/a[1] | Path exists but doesn't match the desired type | The errorCallback is called with an appropriate error code (if the callback was provided). |
|
true |
false |
Path exists | The existing file or directory is removed and replaced with a new one, then the successCallback is called with a FileSystemFileEntry or a FileSystemDirectoryEntry, as appropriate. |
|
true |
false |
Path doesn't exist | The file or directory is created, then a FileSystemFileEntry or a FileSystemDirectoryEntry is passed to the successCallback, as appropriate. |
|
true |
true |
Path exists | The errorCallback is called with an appropriate error, such as FileError.PATH_EXISTS_ERR. |
|
true |
true |
Path doesn't exist | The file or directory is created, then a FileSystemFileEntry or a FileSystemDirectoryEntry is passed to the successCallback, as appropriate. |
|
[1] When create is false, the value of exclusive is irrelevant and ignored.
Specifications
| Specification | Status | Comment |
|---|---|---|
| File and Directory Entries API The definition of 'FileSystemFlags' in that specification. |
Draft | Initial specification. |
This API has no official W3C or WHATWG specification.
Browser compatibility
| Desktop | Mobile | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Basic support | Chrome
Full support
13
| Edge ? | Firefox
Partial support
50
| IE No support No | Opera No support No | Safari No support No | WebView Android
Full support
Yes
| Chrome Android
Full support
Yes
| Edge Mobile ? | Firefox Android
Partial support
50
| Opera Android No support No | Safari iOS No support No | Samsung Internet Android ? |
Legend
- Full support
- Full support
- Partial support
- Partial support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
- Experimental. Expect behavior to change in the future.
- Experimental. Expect behavior to change in the future.
- Non-standard. Expect poor cross-browser support.
- Non-standard. Expect poor cross-browser support.
- See implementation notes.
- See implementation notes.
- Requires a vendor prefix or different name for use.
- Requires a vendor prefix or different name for use.