Code Monkey home page Code Monkey logo

react-native-cloud-fs's Introduction

react-native-cloud-fs

A react-native library for reading and writing files to iCloud Drive (iOS) and Google Drive (Android).

Getting started

Usage

import RNCloudFs from 'react-native-cloud-fs';

fileExists (options)

Returns a promise which when resolved returns a boolean value indicating if the specified path already exists.

const destinationPath = "foo-bar/docs/info.pdf";
const scope = 'visible';

RNCloudFs.fileExists({
  targetPath: destinationPath, 
  scope: scope
})
  .then((exists) => {
    console.log(exists ? "this file exists" : "this file does not exist");
  })
  .catch((err) => {
    console.warn("it failed", err);
  })

targetPath: a path

scope: determines if the user-visible documents (visible) or the app-visible documents (hidden) are searched for the specified path

copyToCloud (options)

Copies the content of a file (or uri) to the target file system. The files will appear in a either a user visible directory, or a dectory that only the app can see. The directory is named after destinationPath. The directory hierarchy for the destination path will be created if it doesn't already exist. If the target file already exists it a new filename is chosen and returned when the promise is resolved.

const sourceUri = {uri: 'https://foo.com/bar.pdf'};
const destinationPath = "foo-bar/docs/info.pdf";
const mimeType = null;
const scope = 'visible';

RNCloudFs.copyToCloud({
  sourcePath: sourceUri, 
  targetPath: destinationPath, 
  mimeType: mimeType, 
  scope: scope
})
  .then((path) => {
    console.log("it worked", path);
  })
  .catch((err) => {
    console.warn("it failed", err);
  })

sourceUri: object with any uri or an absolute file path and optional http headers, e.g:

  • {path: '/foo/bar/file.txt'}
  • {uri: 'file://foo/bar/file.txt'}
  • {uri: 'http://www.files.com/foo/bar/file.txt', 'http-headers': {user: 'foo', password: 'bar'}} (http-headers are android only)
  • {uri: 'content://media/external/images/media/296'} (android only)
  • {uri: 'assets-library://asset/asset.JPG?id=106E99A1-4F6A-45A2-B320-B0AD4A8E8473&ext=JPG'} (iOS only)

targetPath: a relative path including a filename under which the file will be placed, e.g:

  • my-cloud-text-file.txt
  • foo/bar/my-cloud-text-file.txt

mimeType: a mime type to store the file with or null (android only) , e.g:

  • text/plain
  • application/json
  • image/jpeg

scope: a string to specify if the user can access the document (visible) or not (hidden)

listFiles (options)

Lists files in a directory along with some file metadata. The scope determines if the file listing takes place in the app folder or the public user documents folder.

const path = "dirA/dirB";
const scope = 'hidden';

RNCloudFs.listFiles({targetPath: path, scope: scope})
  .then((res) => {
    console.log("it worked", res);
  })
  .catch((err) => {
    console.warn("it failed", err);
  })

targetPath: a path representing a folder to list files from

scope: a string to specify if the files are the user-visible documents (visible) or the app-visible documents (hidden)

react-native-cloud-fs's People

Contributors

joegoodall1 avatar npomfret avatar viktoriiamialo avatar viktoriyamyalo avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.