vvvfs 0.0.1-alpha.2 → 0.0.2

package/README.md

@@ -1,6 +1,6 @@
 # VVVFS
 
-一个使用Dexie.js，基于IndexedDB的Linux虚拟文件系统
+一个使用Dexie.js，基于IndexedDB的轻量、简单的Linux虚拟文件系统
 
 ## 快速开始
 
@@ -30,7 +30,9 @@ const VVVFS = require("vvvfs"); // CommonJS
 3. 初始化
 
 ```javascript
-const vvvfs = new VVFS("vvvfs"); // 创建一个名为vvvfs的虚拟文件系统
+const vvvfs = new VVVFS("vvvfs", {
+  throwError: true, // 设置为true后，操作文件失败时，不会返回false，而是会抛出错误
+}); // 创建一个名为vvvfs的虚拟文件系统
 ```
 
 4. 使用
@@ -39,18 +41,18 @@ const vvvfs = new VVFS("vvvfs"); // 创建一个名为vvvfs的虚拟文件系统
 // 所有操作都是异步的
 (async function () {
   await vvvfs.reset(); // 重置文件系统
-  await vvvfs.mkdir("/home/user/Desktop"); // 创建目录
-  await vvvfs.write(
+  await vvvfs.createDir("/home/user/Desktop"); // 创建目录，返回true和false
+  await vvvfs.writeText(
     "/home/user/Desktop/test.txt",
-    new File(["Hello World!"], "test.txt", { type: "text/plain" }),
-  ); // 写入文件
-  console.log(await vvvfs.read("/home/user/Desktop/test.txt")); // 读取文件
-  await vvvfs.delete("/home/user/Desktop/test.txt"); // 删除文件
+    "Hello World!"
+  ); // 写入文本文件，写入文件还包括write(path: string, content: Blob)和writeJson(path: string, content: Record<string, any>)方法，返回true和false
+  console.log(await vvvfs.readText("/home/user/Desktop/test.txt")); // 读取文本文件，读取文件还包括read(path: string): Blob和readJson(path: string): Record<string, any>方法
+  await vvvfs.delete("/home/user/Desktop/test.txt"); // 删除文件，返回true和false
   if (await vvvfs.exists("/home/user/Desktop")) {
-    // 判断目录是否存在
+    // 判断文件或目录是否存在
   }
-  console.log(await vvvfs.list("/home/user/Desktop")); // 列出目录下的文件
-  if (await vvvfs.isDirectory("/home/user/Desktop")) {
+  console.log(await vvvfs.list("/home/user/Desktop")); // 列出目录下的文件，返回string[]
+  if (await vvvfs.isDir("/home/user/Desktop")) {
     // 判断是否为目录
   }
   if (await vvvfs.isFile("/home/user/Desktop/test.txt")) {
@@ -58,17 +60,24 @@ const vvvfs = new VVFS("vvvfs"); // 创建一个名为vvvfs的虚拟文件系统
   }
   await vvvfs.rename(
     "/home/user/Desktop/test.txt",
-    "/home/user/Desktop/test2.txt",
-  ); // 重命名文件
+    "test2.txt",
+  ); // 重命名文件，返回true和false
   await vvvfs.move(
     "/home/user/Desktop/test2.txt",
     "/home/user/Desktop/test.txt",
-  ); // 移动文件
+  ); // 移动文件，返回true和false
   await vvvfs.copy(
     "/home/user/Desktop/test.txt",
     "/home/user/Desktop/test2.txt",
-  ); // 复制文件
-  await vvvfs.chmod("/home/user/Desktop/test.txt", 0o777); // 修改文件权限
-  await vvvfs.chown("/home/user/Desktop/test.txt", "root", "root"); // 修改文件所有者
+  ); // 复制文件，返回true和false
+  await vvvfs.search("/home/user/Desktop", "test.txt"); // 搜索文件，返回string[]
 })();
 ```
+
+## 更新日志
+
+### 0.0.2
+ - 添加 `throwError` 选项，默认为 `false`
+
+### 0.0.1
+- 发布正式版