cordova-fileutil - npm Package Compare versions

Comparing version 2.0.1 to 2.1.0

cordovaFileUtil.js

@@ -7,3 +7,2 @@ 'use strict';
         if (CordovaFileUtil._instance) return CordovaFileUtil._instance;
-
         CordovaFileUtil._instance = this;
@@ -44,7 +43,5 @@ }
                     let reader = new FileReader();
-
                     reader.onloadend = (r) => {
                         resolve(String(r.target.result));
                     };
-
                     reader.readAsText(file);
@@ -65,5 +62,3 @@ }, (e) => {
                     fileWriter.onwriteend = () => { resolve(); };
-
                     fileWriter.onerror = (e) => { reject(e); };
-
                     fileWriter.write(new Blob([writeData]), { type: 'text/plain' });
@@ -70,0 +65,0 @@ });

package.json

 {
   "name": "cordova-fileutil",
-  "version": "2.0.1",
-  "description": "This package makes it easy to use the 'cordova-plugin-file' plug-in",
+  "version": "2.1.0",
+  "type": "module",
+  "description": "'cordova-plugin-file' easily",
   "keywords": [
-    "file util",
-    "file",
-    "web",
-    "app",
+    "cordova-plugin-file",
+    "cordova file",
+    "browser",
     "android",
     "ios",
-    "desktop",
     "frontle",
-    "cordova",
-    "electron",
-    "chrome extension"
+    "cordova"
   ],
@@ -18,0 +15,0 @@ "author": "Yun HyeongJun <[e-mail]>",

README.md

@@ -1,15 +0,10 @@
-# cordova-FileUtil
+# cordova-fileutil
 
-This package makes it easy to use the "cordova-plugin-file" plug-in
+> 'cordova-plugin-file' easily
 
-[![NPM Version][npm-version-image]][npm-url]
+## Usage
 
-[![NPM Install Size][npm-install-size-image]][npm-install-size-url]
-
-[![NPM Downloads][npm-downloads-image]][npm-downloads-url]
-
 ```javascript
-import {CordovaFileUtil} from "../../browser_modules/cordova-fileutil/cordovaFileUtil.js";
+import {CordovaFileUtil} from "cordovaFileUtil.js";
 
-
 // get instance
@@ -19,119 +14,96 @@ const cordovaFileUtil = new CordovaFileUtil();
 // get directory entry
-const dirEntry = cordovaFileUtil.getDirEntry(cordova.file.dataDirectory, 'testFolder');
+const dirEntry = await cordovaFileUtil.getDirEntry(cordova.file.dataDirectory, 'testFolder');
 
 // get file entry
-const fileEntry = cordovaFileUtil.getFileEntry('test.text', dirEntry);
+const fileEntry = await cordovaFileUtil.getFileEntry('test.text', dirEntry);
 
 // read file
-const readData = cordovaFileUtil.read(fileEntry);
+const readData = await cordovaFileUtil.read(fileEntry);
 
 // write file
-cordovaFileUtil.write(fileEntry, "test text");
+await cordovaFileUtil.write(fileEntry, "test text");
 
 // remove file
-cordovaFileUtil.remove('test.text', dirEntry);
+await cordovaFileUtil.remove('test.text', dirEntry);
 
 // remove directory
-cordovaFileUtil.removeDir(dirEntry);
+await cordovaFileUtil.removeDir(dirEntry);
 ```
 
+## Install
 
+**NPM**
 
-## Installation
+```shell
+npm install cordova-fileutil
+```
 
-**How to install from Frontle**
+**Frontle**
 
 ```shell
-$ frontle install cordova-fileutil
+frontle install cordova-fileutil
 ```
 
+**Download file**
 
+https://github.com/Artifriends-inc/cordova-FileUtil
 
-**How to install from Web**
+## API
 
-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
+Creating a CordovaFileUtil Object. Single tone pattern used
 
 ```javascript
-// get instance
 const cordovaFileUtil = new CordovaFileUtil();
 ```
 
+#### .getDirEntry(path, folderName, create = true)
 
+Get directory entry
 
-#### cordovaFileUtil.getDirEntry(path, folderName, create = true)
-
-Get folder entry, If the "create" option is true, a folder is created
-
 ```javascript
-// get directory entry
-const dirEntry = cordovaFileUtil.getDirEntry(cordova.file.dataDirectory, 'testFolder');
+const dirEntry = await cordovaFileUtil.getDirEntry(cordova.file.dataDirectory, 'testFolder');
 ```
 
+#### .getFileEntry(fileName, dirEntry, create = true)
 
+Get file entry
 
-#### cordovaFileUtil.getFileEntry(fileName, dirEntry, create = true)
-
-Get file entry, If the "create" option is true, a file is created
-
 ```javascript
-// get file entry
-const fileEntry = cordovaFileUtil.getFileEntry('test.text', dirEntry);
+const fileEntry = await cordovaFileUtil.getFileEntry('test.text', dirEntry);
 ```
 
+#### .read(fileEntry)
 
+Read file data
 
-#### read(fileEntry)
-
-Reads file data
-
 ```javascript
-// read file
-const readData = cordovaFileUtil.read(fileEntry);
+const readData = await cordovaFileUtil.read(fileEntry);
 ```
 
+#### .write(fileEntry, writeData)
 
-
-#### write(fileEntry, writeData)
-
 Write file data
 
 ```javascript
-// write file
-cordovaFileUtil.write(fileEntry, "test text");
+await cordovaFileUtil.write(fileEntry, "test text");
 ```
 
+#### .remove(fileName, dirEntry)
 
-
-#### remove(fileName, dirEntry)
-
 Remove file
 
 ```javascript
-// remove file
-cordovaFileUtil.remove('test.text', dirEntry);
+await cordovaFileUtil.remove('test.text', dirEntry);
 ```
 
+#### .removeDir(dirEntry)
 
-
-#### removeDir(dirEntry)
-
 Remove directory
 
 ```javascript
-// remove directory
-cordovaFileUtil.removeDir(dirEntry);
+await cordovaFileUtil.removeDir(dirEntry);
 ```
 
-
-
 ## People
@@ -141,15 +113,4 @@
 
-
-
 ## License
 
-[MIT](LICENSE)
-
-
-
-[npm-downloads-image]: https://badgen.net/npm/dm/cordova-fileutil
-[npm-downloads-url]: https://npmcharts.com/compare/cordova-fileutil?minimal=true
-[npm-install-size-image]: https://badgen.net/packagephobia/install/cordova-fileutil
-[npm-install-size-url]: https://packagephobia.com/result?p=cordova-fileutil
-[npm-url]: https://npmjs.org/package/cordova-fileutil
-[npm-version-image]: https://badgen.net/npm/v/cordova-fileutil
+[MIT](LICENSE)

No alert changes

Improved metrics

Is type module

Yes

Worsened metrics

Total package byte prevSize

7058

decreased by-13.6%

Number of lines in readme file

114

decreased by-25.97%

No dependency changes