cordova-fileutil/README.md

'cordova-plugin-file' easily

# cordova-fileutil

> 'cordova-plugin-file' easily

## Usage

```javascript
import cordova_fileutil from "browser_modules/cordova-fileutil/module.js";
const {CordovaFileUtil} = cordova_fileutil;

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

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

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

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

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

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

// remove directory
await cordovaFileUtil.removeDir(dirEntry);
```

## Install

**Frontle**

```shell
frontle install cordova-fileutil
```

**Download file**

https://github.com/Artifriends-inc/cordova-FileUtil

## API

#### new CordovaFileUtil()

Creating a CordovaFileUtil Object. Single tone pattern used

```javascript
const cordovaFileUtil = new CordovaFileUtil();
```

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

Get directory entry

```javascript
const dirEntry = await cordovaFileUtil.getDirEntry(cordova.file.dataDirectory, 'testFolder');
```

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

Get file entry

```javascript
const fileEntry = await cordovaFileUtil.getFileEntry('test.text', dirEntry);
```

#### .read(fileEntry)

Read file data

```javascript
const readData = await cordovaFileUtil.read(fileEntry);
```

#### .write(fileEntry, writeData)

Write file data

```javascript
await cordovaFileUtil.write(fileEntry, "test text");
```

#### .remove(fileName, dirEntry)

Remove file

```javascript
await cordovaFileUtil.remove('test.text', dirEntry);
```

#### .removeDir(dirEntry)

Remove directory

```javascript
await cordovaFileUtil.removeDir(dirEntry);
```

## People

The original author of cordova-fileutil is [MushStory](https://github.com/MushStory)

## License

[MIT](LICENSE)