-
Notifications
You must be signed in to change notification settings - Fork 0
File System Access API
File System API was introduced in 0.5.0, including the following methods
- Differences between File Source (read it first)
- asset (0.6.2)
- dirs
- createFile
- writeFile (0.6.0)
- appendFile (0.6.0)
- readFile (0.6.0)
- readStream
- writeStream
- unlink
- mkdir
- ls
- mv
- cp
- exists
- isDir
- stat
- lstat
- scanFile (Android only)
fs APIs provides file access ability to your app, there're generally 3 kinds of file you may need to know when using fs APIs.
Normal Files
These files are created by your app using fs, or fetch API, you can do any operation on these files.
Asset Files
Assets files are compiled into the app bundle so generally they're readonly, only the following operations work on asset files.
- cp
- readFile
- readStream
- stat
You can also pass a path of asset file to body of a fetch request by wrap it using fs.asset.
const { fs, fetch, wrap } = RNFetchBlob
fetch('POST', 'http://myupload.com/upload', {
'Content-Type' : 'application/octet-stream' },
wrap(fs.asset('my-asset-file.png')))Files from Camera Roll
Files come from CameraRoll has a different kind of URI, which should looks like assets-library:// on IOS and content:// on Android, these files are just like asset files.
- These files are
readonly, you CAN NOT change them. - You CAN
copyandreadthese files. - You CAN pass these kind of URI to body of
fetchrequest directly (usewrap).
This constant is a hash map contains common used folders:
- DocumentDir
- CacheDir
- DCIMDir (Android Only)
- DownloadDir (Android Only)
- MusicDir (Android Only)
- PictureDir (Android Only)
- MovieDir (Android Only)
- RingtoneDir (Android Only)
- SDCard (0.9.5+ Android Only)
const dirs = RNFetchBlob.fs.dirs
console.log(dirs.DocumentDir)
console.log(dirs.CacheDir)
console.log(dirs.DCIMDir)
console.log(dirs.DownloadDir)If you're going to make downloaded file visible in Android
Downloadsapp, please see Show Downloaded File and Notification in Android Downloads App.
The path which this new file will be created.
Content of the new file, when encoding is ascii, this argument shoud be an array contains number 0~255.
Encoding of content.
the following expressions are equivalent.
const fs = RNFetchBlob.fs
const base64 = RNFetchBlob.base64
fs.createFile(NEW_FILE_PATH, 'foo', 'utf8')
fs.createFile(NEW_FILE_PATH, [102, 111, 111], 'ascii')
fs.createFile(NEW_FILE_PATH, base64.encode('foo'), 'base64')0.6.0
The path of the file to write.
Data that write to the path, should be an utf8/base64 encoded string, or an array contains numbers between 0-255.
Encoding of input data.
writeFile API replaces content in the file, if you're going to append data to existing file, you should use appendFile or writeStream.
// write UTF8 data to file
RNFetchBlob.fs.writeFile(PATH_TO_WRITE, 'foo', 'utf8')
.then(()=>{ ... })
// write bytes to file
RNFetchBlob.fs.writeFile(PATH_TO_WRITE, [102,111,111], 'ascii')
.then(()=>{ ... })
// write base64 data to file
RNFetchBlob.fs.writeFile(PATH_TO_WRITE, RNFetchBlob.base64.encode('foo'), 'base64')
.then(()=>{ ... })
// write file using content of another file
RNFetchBlob.fs.writeFile(PATH_TO_WRITE, PATH_TO_ANOTHER_FILE, 'uri')
.then(()=>{ ... })
// the file should have content
// foo0.5.0
The path to the file the stream is writing to.
Encoding of input data.
Will new data append after existing file or not.
Calling writeStream method will returns a Promise, which resolves a RNFetchBlobWriteSteam instance when stream opened successfully.
// write utf8 data
RNFetchBlob.fs.writeStream(PATH_TO_WRITE, 'utf8')
.then((stream) => {
stream.write('foo')
return stream.close()
})
// write ASCII data
RNFetchBlob.fs.writeStream(PATH_TO_WRITE, 'ascii')
.then((stream) => {
// write char `f`
stream.write([102])
// write char `o`, `o`
stream.write([111,111])
return stream.close()
})
// write BASE64
RNFetchBlob.fs.writeStream(PATH_TO_WRITE, 'base64')
.then((stream) => {
stream.write(RNFetchBlob.base64.encode('foo'))
return stream.close()
})0.6.0
The path of the file to write.
Data that write to the path, should be an utf8/base64 encoded string, or an array contains numbers between 0-255.
Encoding of input data.
appendFile is will append content after existing data, if you're going to overwrite file content, you should use writeFile or writeStream.
// write UTF8 data to file
RNFetchBlob.fs.appendFile(PATH_TO_WRITE, 'foo', 'utf8')
.then(()=>{ ... })
// write bytes to file
RNFetchBlob.fs.appendFile(PATH_TO_WRITE, [102,111,111], 'ascii')
.then(()=>{ ... })
// write base64 data to file
RNFetchBlob.fs.appendFile(PATH_TO_WRITE, RNFetchBlob.base64.encode('foo'), 'base64')
.then(()=>{ ... })
// the file should have content
// foofoofoo
// write file using content of another file
RNFetchBlob.fs.appendFile(PATH_TO_WRITE, PATH_TO_ANOTHER_FILE, 'uri')
.then(()=>{ ... })0.6.0
Path of the file to file.
Decoder to decode the file data, should be one of base64, ascii, and utf8, it uses utf8 by default.
Read the file from the given path, if the file is large, you should consider use readStream instead.
RNFetchBlob.fs.readFile(PATH_TO_READ, 'base64')
.then((data) => {
// handle the data ..
})readStream(path, encoding, bufferSize, interval):Promise<RNFBReadStream>
0.5.0
The path to the file the stream is reading from.
Encoding of the data.
Buffer size of read stream, default to 4096 and 4095(when encoding is base64)
0.9.4
This argument is introduced in 0.9.4, which limits the event dispatch frequency when sending chunks to JS context. You should set appropriate value along with bufferSize when reading large file.
readStream returns a promise which will resolve RNFetchBlobReadStream.
RNFetchBlob.fs.readStream(PATH_TO_READ, 'utf8')
.then((stream) => {
let data = ''
stream.open()
stream.onData((chunk) => {
data += chunk
})
stream.onEnd(() => {
console.log(data)
})
})0.5.0
Create a directory named path
RNFetchBlob.fs.mkdir(PATH_TO_CREATE)
.then(() => { ... })
.catch((err) => { ... })0.5.0
List files and directories in a path
RNFetchBlob.fs.ls(PATH_TO_LIST)
// files will an array contains filenames
.then((files) => {
console.log(files)
})0.5.0
Move a file's location
RNFetchBlob.fs.mv(FROM_PATH, TO_PATH)
.then(() => { ... })
.catch(() => { ... })Copy a file.
RNFetchBlob.fs.cp(SRC_PATH, DEST_PATH)
.then(() => { ... })
.catch(() => { ... })0.5.0
Check if a file exist at path
RNFetchBlob.fs.exists(PATH_OF_FILE)
.then((exist) => {
console.log(`file ${exist ? '' : 'not'} exists`)
})
.catch(() => { ... })Check the file at path is a directory or not. Resolves with false when the path is not a directory, or it does not exists.
RNFetchBlob.fs.exists(PATH_OF_FILE)
.then((isDir) => {
console.log(`file is ${isDir ? '' : 'not'} a directory`)
})0.5.0
Delete a file at path
RNFetchBlob.fs.unlink(path)
.then(() => { ... })
.catch((err) => { ... })lstat(path:string):Promise<RNFetchBlobStat>
0.5.0
Get statistic data of files in a directory, the result data will be an array of RNFetchBlobStat object.
RNFetchBlob.fs.lstat(PATH_OF_A_FOLDER)
.then((stats) => {})
.catch((err) => {})stat(path:string):Promise<RNFetchBlobStat>
0.5.0
Similar get statistic a data or a directory. the result data will be a RNFetchBlobStat object.
RNFetchBlob.fs.stat(PATH_OF_THE_TARGET)
.then((stats) => {})
.catch((err) => {})0.5.1
Connect Media Scanner and scan the file. see Android Media Scanner, and Downloads App Support chapter for more information.
0.6.2
When the file comes from app bundle assets, you should use this method to prepend a prefix bundle-assets:// so that the fs APIs know this is a file in app bundle.
let path = RNFetchBlob.fs.asset('my-asset.jpg')Asset files are readonly, therefore there's some limitations when dealing with assets. Please see Differences between File Source for more detail.