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 FileSystemEntry
interface's method copyTo
()
copies the file specified by the entry to a new location on the file system. There are some typical restrictions on what you can do:
- A directory can't be copied into itself.
- An entry can't be copied into its parent directory unless you specify a new name.
- When copying a directory, the copy is always recursive; you can't leave out subfolders.
Syntax
FileSystemEntry.copyTo(newParent[, newName][, successCallback][, errorCallback]);
Parameters
newParent
- A
FileSystemDirectoryEntry
object specifying the destination directory for the copy operation. newName
Optional- If this parameter is provided, the copy is given this string as its new file or directory name.
successCallback
Optional- A function which is called when the copy operation is succesfully completed. Receives a single input parameter: a
FileSystemEntry
based object providing the copied item's new details. errorCallback
Optional- An optional callback which is executed if an error occurs while copying the items. There's a single parameter: a
FileError
describing what went wrong.
Return value
Errors
FileError.INVALID_MODIFICATION_ERR
- The requested operation involves an impossible change, such as moving a directory inside itself or one of its own child directories, or copying an item within the same directory without renaming it.
FileError.QUOTA_EXCEEDED_ERR
- The operation exceeded the user's storage quota, or there isn't enough storage space left to complete the operation.
Example
This example shows how a temporary log file might be moved into a more permanent "log" directory.
workingDirectory.getFile("tmp/log.txt", {}, function(fileEntry) { workingDirectory.getDirectory("log", {}, function(dirEntry) { fileEntry.copyTo(dirEntry); }, handleError); }, handleError);
Specifications
Specification | Status | Comment |
---|---|---|
File and Directory Entries API The definition of 'copyTo()' in that specification. |
Draft | Initial specification. |
This API has no official W3C or WHATWG specification.
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
copyTo | Chrome Full support 13 | Edge No support No | Firefox No support No | IE No support No | Opera No support No | Safari No support No | WebView Android Full support Yes | Chrome Android Full support Yes | Firefox Android No support No | Opera Android No support No | Safari iOS No support No | Samsung Internet Android ? |
Legend
- Full support
- Full 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.