Skip to main content

CloudStorage

The CloudStorage provides the core functionality of the library. File operations loosely follow the conventions of Node's fs.

import { CloudStorage } from 'react-native-cloud-storage';

Definitions​

path​

When a method takes a path parameter, you should provide a full path without leading or trailing slashes:

  • ❌ /some/file
  • ❌ file:///some/file
  • ❌ some/file/
  • ❌ some/directory/
  • ✅ some/file
  • ✅ some/directory
caution

When creating files or directories, always make sure that all directories in the tree already exist. Otherwise the library will throw a CloudStorageErrorCode.DIRECTORY_NOT_FOUND.

Methods​

exists(path, scope)​

Tests whether or not the file or directory at the given path exists.

Parameters:

  • path (string): Required. The path to test.
  • scope (CloudStorageScope): Required. The storage scope (documents/app data) to use.

Returns: A Promise that resolves to a boolean. true if a file or directory exists at the given path, false otherwise.

getGoogleDriveAccessToken()​

Gets the currently stored Google Drive access token (see setGoogleDriveAccessToken()).

Returns: A Promise that resolves to the string value of the access token, or undefined if it hasn't been set so far.

isCloudAvailable()​

Tests whether or not the cloud storage is available. On iOS, this actually verifies with the system whether or not iCloud is available. This might not be the case right at app launch or when the user is not logged into iCloud. On Android, this simply checks whether or not a Google Drive API access token has been set using setGoogleDriveAccessToken.

Returns: A Promise that resolves to a boolean. true if the cloud storage is available, false otherwise.

mkdir(path, scope)​

Creates a new directory at the given path.

Parameters:

  • path (string): Required. The path of the new directory to create. All parent directories must already exist.
  • scope (CloudStorageScope): Required. The storage scope (documents/app data) to use.

Returns: A Promise that resolves once the directory has been created.

readdir(path, scope)​

Reads the files and directories contained in the directory at the given path. Does not include . and .. entries.

Parameters:

  • path (string): Required. The full pathname of the directory to read.
  • scope (CloudStorageScope): Required. The storage scope (documents/app data) to use.

Returns: A Promise that resolves to an array of strings containing the names of the files and directories in the given directory.

readFile(path, scope)​

Reads the file at the given path into a string.

Parameters:

  • path (string): Required. The full pathname of the file to read.
  • scope (CloudStorageScope): Required. The storage scope (documents/app data) to use.

Returns: A Promise that resolves to a string containing the file's content.

setGoogleDriveAccessToken(accessToken)​

Provide a valid Google Drive access token to the library which in order to make calls to the Google Drive API.

The access token is stored statically and therefore only needs to be provided once (until the token expires!) but is available throughout the whole project.

Parameters:

  • accessToken (string): Required. The access token to use.

Returns: void

setThrowOnFilesWithSameName(enable)​

If enabled, the library will throw before a file operation if there are multiple files with the given path found. Does not have any effect on iOS. Enabling this will disable any subscribers created via subscribeToFilesWithSameName(). For more information, see here.

stat(path, scope)​

Gets several file statistics of the file at the given path.

Parameters:

  • path (string): Required. The full pathname of the file to stat.
  • scope (CloudStorageScope): Required. The storage scope (documents/app data) to use.

Returns: A Promise that resolves to CloudStorageFileStat object containing the statistics.

subscribeToFilesWithSameName(subscriber)​

Creates a subscription that receives events when files with the same filename in the same parent directory are detected. Does not fire anything on iOS. For more information, see here.

Parameters:

  • subscriber (({ path: string, fileIds: string[] }) => void): A callback which is fired when files with the same filenames were detected during a file operation. The callback will include an object which includes the path of the files and an array of fileIds from the Google Drive API.

Returns: An object which contains a remove() method to unsubscribe again.

unlink(path, scope)​

Deletes the file at the given path.

Parameters:

  • path (string): Required. The full pathname of the file to delete.
  • scope (CloudStorageScope): Required. The storage scope (documents/app data) to use.

Returns: A Promise that resolves to void once the file has been deleted.

writeFile(path, data, scope)​

Writes the data to the given path. Creates the file if it doesn't exist yet and overwrites it otherwise.

Parameters:

  • path (string): Required. The path including the filename to write to.
  • content (string): Required. The content to write.
  • scope (CloudStorageScope): Required. The storage scope (documents/app data) to use.

Returns: A Promise that resolves to void once the file has been written.