expo-file-system v16.0.9

expo-file-system

Installation

iOS (Cocoapods)

If you're using Cocoapods, add the dependency to your Podfile:

pod 'EXFileSystem'

and run pod install.

iOS (no Cocoapods)

1. In XCode, in the project navigator, right click Libraries ➜ Add Files to [your project's name]
2. Go to node_modules ➜ expo-file-system and add EXFileSystem.xcodeproj
3. In XCode, in the project navigator, select your project. Add libEXFileSystem.a to your project's Build Phases ➜ Link Binary With Libraries
4. Run your project (Cmd+R).

Android

1. Append the following lines to android/settings.gradle:

   include ':expo-file-system'
   project(':expo-file-system').projectDir = new File(rootProject.projectDir, '../node_modules/expo-file-system/android')
   
   include ':expo-file-system-interface'
   project(':expo-file-system-interface').projectDir = new File(rootProject.projectDir, '../node_modules/expo-file-system-interface/android')

2. Insert the following lines inside the dependencies block in android/app/build.gradle:

   compile project(':expo-file-system')
   compile project(':expo-file-system-interface')

Introduction

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'.

Some FileSystem functions are able to read from (but not write to) other locations. Currently FileSystem.getInfoAsync() and FileSystem.copyAsync() are able to read from URIs returned by CameraRoll.getPhotos() from React Native.

FileSystem.getInfoAsync(fileUri, options)

Get metadata information about a file or directory.

Arguments

• fileUri (string) -- file:// URI to the file or directory, or a URI returned by CameraRoll.getPhotos().

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

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

  • size (boolean) -- Whether to include the size of the file if operating on a source from CameraRoll.getPhotos() (skipping this can prevent downloading the file if it's stored in iCloud, for example). The size is always returned for file:// locations.

Returns

If no item exists at this URI, returns { exists: false, isDirectory: false }. Else returns 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 from CameraRoll.getPhotos(), 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)

Read the entire contents of a file as a string.

Arguments

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

Returns

A string containing the entire contents of the file.

FileSystem.writeAsStringAsync(fileUri, contents)

Write the entire contents of a file as a string.

Arguments

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

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

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:// 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:// 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.

Arguments

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

  • from (string) -- file:// URI to the file or directory to copy, or a URI returned by CameraRoll.getPhotos().

  • 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. false by default.

FileSystem.readDirectoryAsync(fileUri)

Enumerate the contents of a directory.

Arguments

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

Returns

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.

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.

• 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.

Returns

Returns 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.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.

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.

• 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.

• 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 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 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 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.

Example

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(downloadJson);
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);
}