Expo FileSystem

GitHub

npm

expo-file-system provides access to a file system stored locally on the device. Within Expo Go, each project has a separate file system and has no access to the file system of other Expo projects. However, it can save content shared by other projects to the local filesystem, as well as share local files with other projects. It is also capable of uploading and downloading files from network URLs.

Platform Compatibility

Installation

If you're installing this in a bare React Native app, you should also follow these additional installation instructions.

Configuration in app.json/app.config.js

Usage

Downloading files

const callback = downloadProgress => {
  const progress = downloadProgress.totalBytesWritten / downloadProgress.totalBytesExpectedToWrite;
  this.setState({
    downloadProgress: progress,
  });
};

const downloadResumable = FileSystem.createDownloadResumable(
  'http://techslides.com/demos/sample-videos/small.mp4',
  FileSystem.documentDirectory + 'small.mp4',
  {},
  callback
);

try {
  const { uri } = await downloadResumable.downloadAsync();
  console.log('Finished downloading to ', uri);
} catch (e) {
  console.error(e);
}

try {
  await downloadResumable.pauseAsync();
  console.log('Paused download operation, saving for future retrieval');
  AsyncStorage.setItem('pausedDownload', JSON.stringify(downloadResumable.savable()));
} catch (e) {
  console.error(e);
}

try {
  const { uri } = await downloadResumable.resumeAsync();
  console.log('Finished downloading to ', uri);
} catch (e) {
  console.error(e);
}

//To resume a download across app restarts, assuming the the DownloadResumable.savable() object was stored:
const downloadSnapshotJson = await AsyncStorage.getItem('pausedDownload');
const downloadSnapshot = JSON.parse(downloadSnapshotJson);
const downloadResumable = new FileSystem.DownloadResumable(
  downloadSnapshot.url,
  downloadSnapshot.fileUri,
  downloadSnapshot.options,
  callback,
  downloadSnapshot.resumeData
);

try {
  const { uri } = await downloadResumable.resumeAsync();
  console.log('Finished downloading to ', uri);
} catch (e) {
  console.error(e);
}

Managing Giphy's

import * as FileSystem from 'expo-file-system';

const gifDir = FileSystem.cacheDirectory + 'giphy/';
const gifFileUri = (gifId: string) => gifDir + `gif_${gifId}_200.gif`;
const gifUrl = (gifId: string) => `https://media1.giphy.com/media/${gifId}/200.gif`;

// Checks if gif directory exists. If not, creates it
async function ensureDirExists() {
  const dirInfo = await FileSystem.getInfoAsync(gifDir);
  if (!dirInfo.exists) {
    console.log("Gif directory doesn't exist, creating...");
    await FileSystem.makeDirectoryAsync(gifDir, { intermediates: true });
  }
}

// Downloads all gifs specified as array of IDs
export async function addMultipleGifs(gifIds: string[]) {
  try {
    await ensureDirExists();

    console.log('Downloading', gifIds.length, 'gif files...');
    await Promise.all(gifIds.map(id => FileSystem.downloadAsync(gifUrl(id), gifFileUri(id))));
  } catch (e) {
    console.error("Couldn't download gif files:", e);
  }
}

// Returns URI to our local gif file
// If our gif doesn't exist locally, it downloads it
export async function getSingleGif(gifId: string) {
  await ensureDirExists();

  const fileUri = gifFileUri(gifId);
  const fileInfo = await FileSystem.getInfoAsync(fileUri);

  if (!fileInfo.exists) {
    console.log("Gif isn't cached locally. Downloading...");
    await FileSystem.downloadAsync(gifUrl(gifId), fileUri);
  }

  return fileUri;
}

// Exports shareable URI - it can be shared outside your app
export async function getGifContentUri(gifId: string) {
  return FileSystem.getContentUriAsync(await getSingleGif(gifId));
}

// Deletes whole giphy directory with all its content
export async function deleteAllGifs() {
  console.log('Deleting all GIF files...');
  await FileSystem.deleteAsync(gifDir);
}

API

import * as FileSystem from 'expo-file-system';

Supported URI schemes

Directories

The API takes file:// URIs pointing to local files on the device to identify files. Each app only has read and write access to locations under the following directories:

FileSystem.documentDirectory

file:// URI pointing to the directory where user documents for this app will be stored. Files stored here will remain until explicitly deleted by the app. Ends with a trailing /. Example uses are for files the user saves that they expect to see again.

FileSystem.cacheDirectory

file:// URI pointing to the directory where temporary files used by this app will be stored. Files stored here may be automatically deleted by the system when low on storage. Example uses are for downloaded or generated files that the app just needs for one-time usage.

So, for example, the URI to a file named 'myFile' under 'myDirectory' in the app's user documents directory would be FileSystem.documentDirectory + 'myDirectory/myFile'.

Expo APIs that create files generally operate within these directories. This includes Audio recordings, Camera photos, ImagePicker results, SQLite databases and takeSnapShotAsync() results. This allows their use with the FileSystem API.

Some FileSystem functions are able to read from (but not write to) other locations.

Constants

FileSystem.EncodingType

These values can be used to define how data is read / written.

• FileSystem.EncodingType.UTF8 -- Standard readable format.

• FileSystem.EncodingType.Base64 -- Binary, radix-64 representation.

FileSystem.FileSystemSessionType

These values can be used to define how sessions work on iOS.

• FileSystem.FileSystemSessionType.BACKGROUND -- Using this mode means that the downloading/uploading session on the native side will work even if the application is moved to background. If the task completes while the application is in background, the Promise will be either resolved immediately or (if the application execution has already been stopped) once the app is moved to foreground again.

  Note: The background session doesn't fail if the server or your connection is down. Rather, it continues retrying until the task succeeds or is canceled manually.

• FileSystem.FileSystemSessionType.FOREGROUND -- Using this mode means that downloading/uploading session on the native side will be terminated once the application becomes inactive (e.g. when it goes to background). Bringing the application to foreground again would trigger Promise rejection.

FileSystem.FileSystemUploadType

• FileSystem.FileSystemUploadType.BINARY_CONTENT -- The file will be sent as a request's body. The request can't contain additional data.

• FileSystem.FileSystemUploadType.MULTIPART -- An RFC 2387-compliant request body. The provided file will be encoded into HTTP request. This request can contain additional data.

How to handle such requests?

The simple server in Node.js, which can save uploaded images to disk:

const express = require('express');
const app = express();
const fs = require('fs');
const multer = require('multer');
const upload = multer({ dest: 'uploads/' });

// This method will save the binary content of the request as a file.
app.patch('/binary-upload', (req, res) => {
  req.pipe(fs.createWriteStream('./uploads/image' + Date.now() + '.png'));
  res.end('OK');
});

// This method will save a "photo" field from the request as a file.
app.patch('/multipart-upload', upload.single('photo'), (req, res) => {
  // You can access other HTTP parameters. They are located in the body object.
  console.log(req.body);
  res.end('OK');
});

app.listen(3000, () => {
  console.log('Working on port 3000');
});

Methods

FileSystem.getInfoAsync(fileUri, options)

Get metadata information about a file, directory or external content/asset.

Arguments

• fileUri (string) -- URI to the file or directory. See supported URI schemes.

• options (object) -- A map of options:

  • md5 (boolean) -- Whether to return the MD5 hash of the file. false by default.

  • size (boolean) -- Explicitly specify that the file size should be included. For example, skipping this can prevent downloading the file if it's stored in iCloud. The size is always returned for file:// locations.

Returns

If no item exists at this URI, returns a Promise that resolves to { exists: false, isDirectory: false }. Else returns a Promise that resolves to an object with the following fields:

• exists (boolean) -- true.

• isDirectory (boolean) -- true if this is a directory, false if it is a file

• modificationTime (number) -- The last modification time of the file expressed in seconds since epoch.

• size (number) -- The size of the file in bytes. If operating on a source such as an iCloud file, only present if the size option was truthy.

• uri (string) -- A file:// URI pointing to the file. This is the same as the fileUri input parameter.

• md5 (string) -- Present if the md5 option was truthy. Contains the MD5 hash of the file.

FileSystem.readAsStringAsync(fileUri, options)

Read the entire contents of a file as a string. Binary will be returned in raw format, you will need to append data:image/png;base64, to use it as Base64.

Arguments

• fileUri (string) -- file:// or SAF URI to the file or directory.

• options (object) -- Optional props that define how a file must be read.

  • encoding (EncodingType) -- The encoding format to use when reading the file. Options: FileSystem.EncodingType.UTF8, FileSystem.EncodingType.Base64. Default is FileSystem.EncodingType.UTF8.

  • length (number) -- Optional number of bytes to read. This option is only used when encoding: FileSystem.EncodingType.Base64 and position is defined.

  • position (number) -- Optional number of bytes to skip. This option is only used when encoding: FileSystem.EncodingType.Base64 and length is defined.

Returns

A Promise that resolves to a string containing the entire contents of the file.

FileSystem.writeAsStringAsync(fileUri, contents, options)

Write the entire contents of a file as a string.

Arguments

• fileUri (string) -- file:// or SAF URI to the file or directory. Note: when you're using SAF URI the file needs to exist. You can't create a new file.

• contents (string) -- The string to replace the contents of the file with.

• options (object) -- Optional props that define how a file must be written.

  • encoding (string) -- The encoding format to use when writing the file. Options: FileSystem.EncodingType.UTF8, FileSystem.EncodingType.Base64. Default is FileSystem.EncodingType.UTF8

FileSystem.deleteAsync(fileUri, options)

Delete a file or directory. If the URI points to a directory, the directory and all its contents are recursively deleted.

Arguments

• fileUri (string) -- file:// or SAF URI to the file or directory.

• options (object) -- A map of options:

  • idempotent (boolean) -- If true, don't throw an error if there is no file or directory at this URI. false by default.

FileSystem.moveAsync(options)

Move a file or directory to a new location.

Arguments

• options (object) -- A map of options:

  • from (string) -- file:// or SAF URI to the file or directory at its original location.

  • to (string) -- file:// URI to the file or directory at what should be its new location.

FileSystem.copyAsync(options)

Create a copy of a file or directory. Directories are recursively copied with all of their contents. It can be also used to copy content shared by other apps to local filesystem.

Arguments

• options (object) -- A map of options:

  • from (string) -- URI or SAF URI to the asset, file, or directory to copy. See supported URI schemes.

  • to (string) -- The file:// URI to the new copy to create.

FileSystem.makeDirectoryAsync(fileUri, options)

Create a new empty directory.

Arguments

• fileUri (string) -- file:// URI to the new directory to create.

• options (object) -- A map of options:

  • intermediates (boolean) -- If true, create any non-existent parent directories when creating the directory at fileUri. If false, raises an error if any of the intermediate parent directories does not exist or if the child directory already exists. false by default.

FileSystem.readDirectoryAsync(fileUri)

Enumerate the contents of a directory.

Arguments

• fileUri (string) -- file:// URI to the directory.

Returns

A Promise that resolves to an array of strings, each containing the name of a file or directory contained in the directory at fileUri.

FileSystem.downloadAsync(uri, fileUri, options)

Download the contents at a remote URI to a file in the app's file system. The directory for a local file uri must exist prior to calling this function.

Example

FileSystem.downloadAsync(
  'http://techslides.com/demos/sample-videos/small.mp4',
  FileSystem.documentDirectory + 'small.mp4'
)
  .then(({ uri }) => {
    console.log('Finished downloading to ', uri);
  })
  .catch(error => {
    console.error(error);
  });

Arguments

• url (string) -- The remote URI to download from.

• fileUri (string) -- The local URI of the file to download to. If there is no file at this URI, a new one is created. If there is a file at this URI, its contents are replaced. The directory for the file must exist.

• options (object) -- A map of options:

  • headers (object) -- An object containing all the HTTP header fields and their values for the download network request. The keys and values of the object are the header names and values respectively.

  • md5 (boolean) -- If true, include the MD5 hash of the file in the returned object. false by default. Provided for convenience since it is common to check the integrity of a file immediately after downloading.

  • sessionType (FileSystemSessionType) -- (iOS only) A session type. Determines if tasks can be handled in the background. On Android, sessions always work in the background and you can't change it. Defaults to FileSystemSessionType.BACKGROUND.

Returns

Returns a Promise that resolves to an object with the following fields:

• uri (string) -- A file:// URI pointing to the file. This is the same as the fileUri input parameter.

• status (number) -- The HTTP response status code for the download network request.

• headers (object) -- An object containing all the HTTP response header fields and their values for the download network request. The keys and values of the object are the header names and values respectively.

• md5 (string) -- Present if the md5 option was truthy. Contains the MD5 hash of the file.

FileSystem.uploadAsync(url, fileUri, options)

Upload the contents of the file pointed by fileUri to the remote url.

Example

client

import * as FileSystem from 'expo-file-system';

try {
  const response = await FileSystem.uploadAsync(`http://192.168.0.1:1234/binary-upload`, fileUri, {
    fieldName: 'file',
    httpMethod: 'PATCH',
    uploadType: FileSystem.FileSystemUploadType.BINARY_CONTENT,
  });
  console.log(JSON.stringify(response, null, 4));
} catch (error) {
  console.log(error);
}

server

Please refer to the "how to handle such requests" section - there is code for a simple Node.js server.

Arguments

• url (string) -- The remote URL, where the file will be sent.

• fileUri (string) -- The local URI of the file to send. The file must exist.

• options (object) -- A map of options:

  • headers (object) -- An object containing all the HTTP header fields and their values for the upload network request. The keys and values of the object are the header names and values respectively.

  • httpMethod (String) -- The request method. Accepts values: 'POST', 'PUT', 'PATCH. Default to 'POST'.

  • sessionType (FileSystemSessionType) -- (iOS only) A session type. Determines if tasks can be handled in the background. On Android, sessions always work in the background and you can't change it. Defaults to FileSystemSessionType.BACKGROUND.

  • uploadType (FileSystemUploadType) -- Upload type determines how the file will be sent to the server. Default to FileSystemUploadType.BINARY_CONTENT.

  If uploadType is equal FileSystemUploadType.MULTIPART, more options are available:

  • fieldName (string) -- The name of the field which will hold uploaded file. Defaults to the file name without an extension.

  • mimeType (string) -- The MIME type of the provided file. If not provided, the module will try to guess it based on the extension.

  • parameters (Record<string, string>) -- Additional form properties. They will be located in the request body.

Returns

Returns a Promise that resolves to an object with the following fields:

• status (number) -- The HTTP response status code for the upload network request.

• headers (object) -- An object containing all the HTTP response header fields and their values for the upload network request. The keys and values of the object are the header names and values respectively.

• body (string) -- The body of the server response.

FileSystem.createDownloadResumable(uri, fileUri, options, callback, resumeData)

Create a DownloadResumable object which can start, pause, and resume a download of contents at a remote URI to a file in the app's file system. Please note: You need to call downloadAsync(), on a DownloadResumable instance to initiate the download. The DownloadResumable object has a callback that provides download progress updates. Downloads can be resumed across app restarts by using AsyncStorage to store the DownloadResumable.savable() object for later retrieval. The savable object contains the arguments required to initialize a new DownloadResumable object to resume the download after an app restart. The directory for a local file uri must exist prior to calling this function.

Arguments

• url (string) -- The remote URI to download from.

• fileUri (string) -- The local URI of the file to download to. If there is no file at this URI, a new one is created. If there is a file at this URI, its contents are replaced. The directory for the file must exist.

• options (object) -- A map of options:

  • md5 (boolean) -- If true, include the MD5 hash of the file in the returned object. false by default. Provided for convenience since it is common to check the integrity of a file immediately after downloading.

  • headers (object) -- An object containing any additional HTTP header fields required for the request. The keys and values of the object are the header names and values respectively.

• callback (function) -- This function is called on each data write to update the download progress. An object with the following fields are passed:

  • totalBytesWritten (number) -- The total bytes written by the download operation.

  • totalBytesExpectedToWrite (number) -- The total bytes expected to be written by the download operation. A value of -1 means that the server did not return the Content-Length header and the total size is unknown. Without this header, you won't be able to track the download progress.

  Note: When the app has been moved to the background, this callback won't be fired until it's moved to the foreground.

• resumeData (string) -- The string which allows the api to resume a paused download. This is set on the DownloadResumable object automatically when a download is paused. When initializing a new DownloadResumable this should be null.

FileSystem.DownloadResumable.downloadAsync()

Download the contents at a remote URI to a file in the app's file system.

Returns

Returns a Promise that resolves to an object with the following fields:

• uri (string) -- A file:// URI pointing to the file. This is the same as the fileUri input parameter.

• status (number) -- The HTTP status code for the download network request.

• headers (object) -- An object containing all the HTTP header fields and their values for the download network request. The keys and values of the object are the header names and values respectively.

• md5 (string) -- Present if the md5 option was truthy. Contains the MD5 hash of the file.

FileSystem.DownloadResumable.pauseAsync()

Pause the current download operation. resumeData is added to the DownloadResumable object after a successful pause operation. Returns an object that can be saved with AsyncStorage for future retrieval (the same object that is returned from calling FileSystem.DownloadResumable.savable(). Please see the example below.

Returns

Returns a Promise that resolves to an object with the following fields:

• url (string) -- The remote URI to download from.

• fileUri (string) -- The local URI of the file to download to. If there is no file at this URI, a new one is created. If there is a file at this URI, its contents are replaced.

• options (object) -- A map of options:

  • md5 (boolean) -- If true, include the MD5 hash of the file in the returned object. false by default. Provided for convenience since it is common to check the integrity of a file immediately after downloading.

• resumeData (string) -- The string which allows the API to resume a paused download.

FileSystem.DownloadResumable.resumeAsync()

Resume a paused download operation.

Returns

Returns a Promise that resolves to an object with the following fields:

• uri (string) -- A file:// URI pointing to the file. This is the same as the fileUri input parameter.

• status (number) -- The HTTP status code for the download network request.

• headers (object) -- An object containing all the HTTP header fields and their values for the download network request. The keys and values of the object are the header names and values respectively.

• md5 (string) -- Present if the md5 option was truthy. Contains the MD5 hash of the file.

FileSystem.DownloadResumable.savable()

Returns an object which can be saved with AsyncStorage for future retrieval.

Returns

Returns an object with the following fields:

• url (string) -- The remote URI to download from.

• fileUri (string) -- The local URI of the file to download to. If there is no file at this URI, a new one is created. If there is a file at this URI, its contents are replaced.

• options (object) -- A map of options:

  • md5 (boolean) -- If true, include the MD5 hash of the file in the returned object. false by default. Provided for convenience since it is common to check the integrity of a file immediately after downloading.

• resumeData (string) -- The string which allows the api to resume a paused download.

FileSystem.getContentUriAsync(fileUri)

Take a file:// URI and convert it into content URI (content://) so that it can be access by other applications outside of Expo.

Example

FileSystem.getContentUriAsync(uri).then(cUri => {
  console.log(cUri);
  IntentLauncher.startActivityAsync('android.intent.action.VIEW', {
    data: cUri,
    flags: 1,
  });
});

Arguments

• fileUri (string) -- The local URI of the file. If there is no file at this URI, an exception will be thrown.

Returns

Returns a Promise that resolves to a string containing a content:// URI pointing to the file. The URI is the same as the fileUri input parameter but in a different format.

FileSystem.getFreeDiskStorageAsync()

Gets the available internal disk storage size, in bytes. This returns the free space on the data partition that hosts all of the internal storage for all apps on the device.

Example

FileSystem.getFreeDiskStorageAsync().then(freeDiskStorage => {
  // Android: 17179869184
  // iOS: 17179869184
});

Returns

Returns a Promise that resolves to the number of bytes available on the internal disk, or JavaScript's MAX_SAFE_INTEGER if the capacity is greater than 2⁵³ - 1 bytes.

FileSystem.getTotalDiskCapacityAsync()

Gets total internal disk storage size, in bytes. This is the total capacity of the data partition that hosts all the internal storage for all apps on the device.

Example

FileSystem.getTotalDiskCapacityAsync().then(totalDiskCapacity => {
  // Android: 17179869184
  // iOS: 17179869184
});

Returns

Returns a Promise that resolves to a number that specifies the total internal disk storage capacity in bytes, or JavaScript's MAX_SAFE_INTEGER if the capacity is greater than 2⁵³ - 1 bytes.

Storage Access Framework (Android only)

The StorageAccessFramework is a namespace inside of the expo-file-system module, which encapsulates all functions which can be used with SAF URIs. You can read more about SAF in the Android documentation.

SAF URI

A SAF URI is a URI that is compatible with the Storage Access Framework. It should look like this content://com.android.externalstorage.*. The easiest way to obtain such URI is by requestDirectoryPermissionsAsync method.

API

import { StorageAccessFramework } from 'expo-file-system';

Example Usage

import { StorageAccessFramework } from 'expo-file-system';

// Requests permissions for external directory
const permissions = await StorageAccessFramework.requestDirectoryPermissionsAsync();

if (permissions.granted) {
  // Gets SAF URI from response
  const uri = permissions.directoryUri;

  // Gets all files inside of selected directory
  const files = await StorageAccessFramework.readDirectoryAsync(uri);
  alert(`Files inside ${uri}:\n\n${JSON.stringify(files)}`);
}

Migrating an album

import * as MediaLibrary from 'expo-media-library';
import * as FileSystem from 'expo-file-system';
const { StorageAccessFramework } = FileSystem;

async function migrateAlbum(albumName: string) {
  // Gets SAF URI to the album
  const albumUri = StorageAccessFramework.getUriForDirectoryInRoot(albumName);

  // Requests permissions
  const permissions = await StorageAccessFramework.requestDirectoryPermissionsAsync(albumUri);
  if (!permissions.granted) {
    return;
  }

  const permittedUri = permissions.directoryUri;
  // Checks if users selected the correct folder
  if (!permittedUri.includes(albumName)) {
    return;
  }

  const mediaLibraryPermissions = await MediaLibrary.requestPermissionsAsync();
  if (!mediaLibraryPermissions.granted) {
    return;
  }

  // Moves files from external storage to internal storage
  await StorageAccessFramework.moveAsync({
    from: permittedUri,
    to: FileSystem.documentDirectory!,
  });

  const outputDir = FileSystem.documentDirectory! + albumName;
  const migratedFiles = await FileSystem.readDirectoryAsync(outputDir);

  // Creates assets from local files
  const [newAlbumCreator, ...assets] = await Promise.all(
    migratedFiles.map<Promise<MediaLibrary.Asset>>(
      async fileName => await MediaLibrary.createAssetAsync(outputDir + '/' + fileName)
    )
  );

  // Album was empty
  if (!newAlbumCreator) {
    return;
  }

  // Creates a new album in the scoped directory
  const newAlbum = await MediaLibrary.createAlbumAsync(albumName, newAlbumCreator, false);
  if (assets.length) {
    await MediaLibrary.addAssetsToAlbumAsync(assets, newAlbum, false);
  }
}

StorageAccessFramework.getUriForDirectoryInRoot(folderName)

Gets a SAF URI pointing to a folder in the Android root directory. You can use this function to get URI for StorageAccessFramework.requestDirectoryPermissionsAsync when you trying to migrate an album. In that case, the name of the album is the folder name.

Arguments

• folderName (string) -- The name of the folder which is located in the Android root directory.

Returns

Returns a SAF URI to a folder.

StorageAccessFramework.requestDirectoryPermissionsAsync(initialFileUrl)

Android only. Allows users to select a specific directory, granting your app access to all of the files and sub-directories within that directory.

Arguments

• initialFileUrl (string) -- Optional. The SAF URI of the directory that the file picker should display when it first loads. If URI is incorrect or points to a non-existing folder, it's ignored. Available only on Android R or higher.

Returns

Returns a Promise that resolves to an object with the following fields:

• granted (boolean) -- Whether the permissions were granted.

• directoryUri (string) -- The SAF URI to the user's selected directory. Available only if permissions were granted.

StorageAccessFramework.readDirectoryAsync(dirUri)

Enumerate the contents of a directory.

Arguments

• dirUri (string) -- SAF URI to the directory.

Returns

A Promise that resolves to an array of strings, each containing the full SAF URI of a file or directory contained in the directory at fileUri.

StorageAccessFramework.makeDirectoryAsync(parentUri: string, dirName: string)

Creates a new empty directory.

Arguments

• parentUri (string) -- The SAF URI to the parent directory.

• dirName (string) -- The name of new directory.

Returns

A Promise that resolves to a SAF URI to the created directory.

StorageAccessFramework.createFileAsync(parentUri: string, fileName: string, mimeType: string)

Creates a new empty file.

Arguments

• parentUri (string) -- The SAF URI to the parent directory.

• fileName (string) -- The name of new file without the extension.

• mimeType (string) -- The MIME of new file.

Returns

A Promise that resolves to a SAF URI to the created file.

StorageAccessFramework.writeAsStringAsync(fileUri, contents, options)

Alias to FileSystem.writeAsStringAsync(fileUri, contents, options).

StorageAccessFramework.readAsStringAsync(fileUri, options)

Alias to FileSystem.readAsStringAsync(fileUri, options)

StorageAccessFramework.deleteAsync(fileUri, options)

Alias to FileSystem.deleteAsync(fileUri, options)

StorageAccessFramework.moveAsync(options)

Alias to FileSystem.moveAsync(options)

StorageAccessFramework.copyAsync(options)

Alias to FileSystem.copyAsync(options)

Supported URI schemes

In this table, you can see what type of URI can be handled by each method. For example, if you have an URI, which begins with content://, you cannot use FileSystem.readAsStringAsync(), but you can use FileSystem.copyAsync() which supports this scheme.

On Android no scheme defaults to a bundled resource.

Permissions

Android

The following permissions are added automatically through this library's AndroidManifest.xml.

iOS

No permissions required.