cordova-fileutil

cordova-FileUtil

This package makes it easy to use the "cordova-plugin-file" plug-in

import {CordovaFileUtil} from "../../frontle/browser_modules/cordova-fileutil/cordovaFileUtil.js";


// get instance
const cordovaFileUtil = new CordovaFileUtil();

// get directory entry
const dirEntry = cordovaFileUtil.getDirEntry(cordova.file.dataDirectory, 'testFolder');

// get file entry
const fileEntry = cordovaFileUtil.getFileEntry('test.text', dirEntry);

// read file
const readData = cordovaFileUtil.read(fileEntry);

// write file
cordovaFileUtil.write(fileEntry, "test text");

// remove file
cordovaFileUtil.remove('test.text', dirEntry);

// remove directory
cordovaFileUtil.removeDir(dirEntry);

Installation

How to install from Frontle

$ frontle install cordova-fileutil

How to install from Web

For typical web projects, copy and use the code at cordovaFileUtil.js in below repositorys

https://github.com/Artifriends-inc/cordova-FileUtil (cordovaFileUtil.js)

Function

new CordovaFileUtil()

Get "CordovaFileUtil" object. only one object is created using a single-tone pattern

// get instance
const cordovaFileUtil = new CordovaFileUtil();

cordovaFileUtil.getDirEntry(path, folderName, create = true)

Get folder entry, If the "create" option is true, a folder is created

// get directory entry
const dirEntry = cordovaFileUtil.getDirEntry(cordova.file.dataDirectory, 'testFolder');

cordovaFileUtil.getFileEntry(fileName, dirEntry, create = true)

Get file entry, If the "create" option is true, a file is created

// get file entry
const fileEntry = cordovaFileUtil.getFileEntry('test.text', dirEntry);

read(fileEntry)

Reads file data

// read file
const readData = cordovaFileUtil.read(fileEntry);

write(fileEntry, writeData)

Write file data

// write file
cordovaFileUtil.write(fileEntry, "test text");

remove(fileName, dirEntry)

Remove file

// remove file
cordovaFileUtil.remove('test.text', dirEntry);

removeDir(dirEntry)

Remove directory

// remove directory
cordovaFileUtil.removeDir(dirEntry);

People

The original author of cordova-fileutil is MushStory

License

MIT