File

Improve this doc

This plugin implements a File API allowing read/write access to files residing on the device.

The File class implements static convenience functions to access files and directories.

Example:

import { File } from '@ionic-native/file';

constructor(private file: File) { }

...

this.file.checkDir(this.file.dataDirectory, 'mydir').then(_ => console.log('Directory exists')).catch(err => console.log('Directory doesn\'t exist'));

This plugin is based on several specs, including : The HTML5 File API http: //www.w3.org/TR/FileAPI/ The (now-defunct) Directories and System extensions Latest: http: //www.w3.org/TR/2012/WD-file-system-api-20120417/ Although most of the plugin code was written when an earlier spec was current: http: //www.w3.org/TR/2011/WD-file-system-api-20110419/ It also implements the FileWriter spec : http: //dev.w3.org/2009/dap/file-system/file-writer.html

Repo: https://github.com/apache/cordova-plugin-file

Installation

1. Install the Cordova and Ionic Native plugins:
   

   $ ionic cordova plugin add cordova-plugin-file
   $ npm install --save @ionic-native/file@4
   

2. Add this plugin to your app's module

Supported platforms

• Android
• Browser
• iOS
• macOS
• Windows

Instance Members

applicationDirectory

Read-only directory where the application is installed.

applicationStorageDirectory

Read-only directory where the application is installed.

dataDirectory

Where to put app-specific data files.

cacheDirectory

Cached files that should survive app restarts. Apps should not rely on the OS to delete files in here.

externalApplicationStorageDirectory

Android: the application space on external storage.

externalDataDirectory

Android: Where to put app-specific data files on external storage.

externalCacheDirectory

Android: the application cache on external storage.

externalRootDirectory

Android: the external storage (SD card) root.

tempDirectory

iOS: Temp directory that the OS can clear at will.

syncedDataDirectory

iOS: Holds app-specific files that should be synced (e.g. to iCloud).

documentsDirectory

iOS: Files private to the app, but that are meaningful to other applications (e.g. Office files)

sharedDirectory

BlackBerry10: Files globally available to all apps

cordovaFileError

getFreeDiskSpace()

Get free disk space in Bytes

checkDir(path, dir)

Check if a directory exists in a certain path, directory.

createDir(path, dirName, replace)

Creates a new directory in the specific path. The replace boolean value determines whether to replace an existing directory with the same name. If an existing directory exists and the replace value is false, the promise will fail and return an error.

removeDir(path, dirName)

Remove a directory at a given path.

moveDir(path, dirName, newPath, newDirName)

Move a directory to a given path.

copyDir(path, dirName, newPath, newDirName)

Copy a directory in various methods. If destination directory exists, will fail to copy.

listDir(path, dirName)

List files and directory from a given path.

removeRecursively(path, dirName)

Removes all files and the directory from a desired location.

checkFile(path, file)

Check if a file exists in a certain path, directory.

createFile(path, fileName, replace)

Creates a new file in the specific path. The replace boolean value determines whether to replace an existing file with the same name. If an existing file exists and the replace value is false, the promise will fail and return an error.

removeFile(path, fileName)

Removes a file from a desired location.

writeFile(path, fileName, text, whether)

Write a new file to the desired location.

writeExistingFile(path, fileName, text)

Write to an existing file.

readAsText(path, file)

Read the contents of a file as text.

readAsDataURL(path, file)

Read file and return data as a base64 encoded data url. A data url is of the form: data: [][;base64],

readAsBinaryString(path, file)

Read file and return data as a binary data.

readAsArrayBuffer(path, file)

Read file and return data as an ArrayBuffer.

moveFile(path, fileName, newPath, newFileName)

Move a file to a given path.

copyFile(path, fileName, newPath, newFileName)

Copy a file in various methods. If file exists, will fail to copy.

resolveLocalFilesystemUrl(fileUrl)

Resolves a local file system URL

resolveDirectoryUrl(directoryUrl)

Resolves a local directory url

getDirectory(directoryEntry, directoryName, flags)

Get a directory

getFile(directoryEntry, fileName, flags)

Get a file

IFile

Entry

DirectoryEntry

DirectoryReader

FileSystem