@huxy/fss - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "@huxy/fss",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "title": "fss",
@@ -5,0 +5,0 @@ "feature": "0.0.1",

README.md

@@ -1,3 +0,244 @@
-## fss
+## 文件管理系统
 
+基于 `node.js` 的 `fs` 模块搭建可视化文件管理系统。实现文件（夹）的增删改查功能。
 
+![update1](./img/update1.png)
+
+### 使用
+
+安装：
+
+```
+npm i @huxy/fss
+```
+
+使用：
+
+```javascript
+import fss from '@huxy/fss';
+import configs from './configs/index.js';
+
+const {rootpath, MAXSIZE} = configs;
+
+const apis = fss(rootpath);
+```
+
+指定根目录 `rootpath`，默认为 `'/'` 。
+
+### api 示例
+
+#### 接口列表
+
+```javascript
+const apis = [
+  {
+    name: 'readdir',
+    url: '/fs/readdir',
+    method: 'post',
+  },
+  {
+    name: 'readfile',
+    url: '/fs/readfile',
+    method: 'post',
+  },
+  {
+    name: 'openfile',
+    url: '/fs/openfile',
+    method: 'post',
+  },
+  {
+    name: 'mkdir',
+    url: '/fs/mkdir',
+    method: 'post',
+  },
+  {
+    name: 'touch',
+    url: '/fs/touch',
+    method: 'post',
+  },
+  {
+    name: 'copyfile',
+    url: '/fs/copyfile',
+    method: 'post',
+  },
+  {
+    name: 'movefile',
+    url: '/fs/movefile',
+    method: 'post',
+  },
+  {
+    name: 'rmfile',
+    url: '/fs/rmfile',
+    method: 'post',
+  },
+  {
+    name: 'rnfile',
+    url: '/fs/rnfile',
+    method: 'post',
+  },
+];
+```
+
+#### 读取文件夹
+
+`readdir(path)`
+
+返回当前目录下的文件信息。
+
+```javascript
+export const readdir = async (req, res) => {
+  const {path} = req.body;
+  try {
+    const result = await apis.readdir(path);
+    res.status(200).send({result});
+  } catch (error) {
+    res.status(500).send({message: error.message});
+  }
+};
+```
+
+![diraction](./img/diraction.png)
+
+#### 获取文件信息
+
+`readfile(path)`
+
+```javascript
+export const readfile = async (req, res) => {
+  const {path} = req.body;
+  try {
+    const result = await apis.readfile(path);
+    res.status(200).send({result});
+  } catch (error) {
+    res.status(500).send({message: error.message});
+  }
+};
+```
+
+![detail](./img/detail.png)
+
+#### 读取文件内容
+
+`openfile(path)`
+
+```javascript
+export const openfile = async (req, res) => {
+  const {path} = req.body;
+  try {
+    const result = await apis.openfile(path);
+    res.status(200).send({result});
+  } catch (error) {
+    res.status(500).send({message: error.message});
+  }
+};
+```
+
+![update](./img/update.png)
+
+#### 新建文件夹
+
+`mkdir(path, override)`
+
+```javascript
+export const mkdir = async (req, res) => {
+  const {path, override} = req.body;
+  try {
+    await apis.mkdir(path, override);
+    res.status(200).send({message: '操作成功！'});
+  } catch (error) {
+    res.status(500).send({message: error.message});
+  }
+};
+```
+
+![adddir](./img/adddir.png)
+
+#### 新建文件
+
+`touch(path, override, data)`
+
+```javascript
+export const touch = async (req, res) => {
+  const {path, override, data} = req.body;
+  try {
+    await apis.touch(path, override, data);
+    res.status(200).send({message: '操作成功！'});
+  } catch (error) {
+    res.status(500).send({message: error.message});
+  }
+};
+```
+
+![addfile](./img/addfile.png)
+
+#### 拷贝文件（夹）
+
+`copyfile(src, dst)`
+
+```javascript
+export const copyfile = async (req, res) => {
+  const {src, dst} = req.body;
+  try {
+    await apis.copyfile(src, dst);
+    res.status(200).send({message: '操作成功！'});
+  } catch (error) {
+    res.status(500).send({message: error.message});
+  }
+};
+```
+
+![fileaction](./img/fileaction.png)
+
+#### 移动文件（夹）
+
+`movefile(src, dst)`
+
+```javascript
+export const movefile = async (req, res) => {
+  const {src, dst} = req.body;
+  try {
+    await apis.movefile(src, dst);
+    res.status(200).send({message: '操作成功！'});
+  } catch (error) {
+    res.status(500).send({message: error.message});
+  }
+};
+```
+
+![move](./img/move.png)
+
+#### 删除文件（夹）
+
+`rmfile(path)`
+
+```javascript
+export const rmfile = async (req, res) => {
+  const {path} = req.body;
+  try {
+    await apis.rmfile(path);
+    res.status(200).send({message: '操作成功！'});
+  } catch (error) {
+    res.status(500).send({message: error.message});
+  }
+};
+```
+
+![delete](./img/delete.png)
+
+#### 重命名文件（夹）
+
+`rnfile(path, newpath)`
+
+```javascript
+export const rnfile = async (req, res) => {
+  const {path, newpath} = req.body;
+  try {
+    await apis.rnfile(path, newpath);
+    res.status(200).send({message: '操作成功！'});
+  } catch (error) {
+    res.status(500).send({message: error.message});
+  }
+};
+```
+
+![rename](./img/rename.png)

filesystem.md

-## 文件管理系统
-
-基于 `node.js` 的 `fs` 模块搭建可视化文件管理系统。实现文件（夹）的增删改查功能。
-
-![update1](./update1.png)
-
-### 使用
-
-安装：
-
-```
-npm i @huxy/fss
-```
-
-使用：
-
-```javascript
-import fss from '@huxy/fss';
-import configs from './configs/index.js';
-
-const {rootpath, MAXSIZE} = configs;
-
-const apis = fss(rootpath);
-```
-
-指定根目录 `rootpath`，默认为 `'/'` 。
-
-### api 示例
-
-#### 读取文件夹
-
-`readdir(path)`
-
-返回当前目录下的文件信息。
-
-```javascript
-export const readdir = async (req, res) => {
-  const {path} = req.body;
-  try {
-    const result = await apis.readdir(path);
-    res.status(200).send({result});
-  } catch (error) {
-    res.status(500).send({message: error.message});
-  }
-};
-```
-
-![diraction](./diraction.png)
-
-#### 获取文件信息
-
-`readfile(path)`
-
-```javascript
-export const readfile = async (req, res) => {
-  const {path} = req.body;
-  try {
-    const result = await apis.readfile(path);
-    res.status(200).send({result});
-  } catch (error) {
-    res.status(500).send({message: error.message});
-  }
-};
-```
-
-![detail](./detail.png)
-
-#### 读取文件内容
-
-`openfile(path)`
-
-```javascript
-export const openfile = async (req, res) => {
-  const {path} = req.body;
-  try {
-    const result = await apis.openfile(path);
-    res.status(200).send({result});
-  } catch (error) {
-    res.status(500).send({message: error.message});
-  }
-};
-```
-
-![update](./update.png)
-
-#### 新建文件夹
-
-`mkdir(path, override)`
-
-```javascript
-export const mkdir = async (req, res) => {
-  const {path, override} = req.body;
-  try {
-    await apis.mkdir(path, override);
-    res.status(200).send({message: '操作成功！'});
-  } catch (error) {
-    res.status(500).send({message: error.message});
-  }
-};
-```
-
-![adddir](./adddir.png)
-
-#### 新建文件
-
-`touch(path, override, data)`
-
-```javascript
-export const touch = async (req, res) => {
-  const {path, override, data} = req.body;
-  try {
-    await apis.touch(path, override, data);
-    res.status(200).send({message: '操作成功！'});
-  } catch (error) {
-    res.status(500).send({message: error.message});
-  }
-};
-```
-
-![addfile](./addfile.png)
-
-#### 拷贝文件（夹）
-
-`copyfile(src, dst)`
-
-```javascript
-export const copyfile = async (req, res) => {
-  const {src, dst} = req.body;
-  try {
-    await apis.copyfile(src, dst);
-    res.status(200).send({message: '操作成功！'});
-  } catch (error) {
-    res.status(500).send({message: error.message});
-  }
-};
-```
-
-![fileaction](./fileaction.png)
-
-#### 移动文件（夹）
-
-`movefile(src, dst)`
-
-```javascript
-export const movefile = async (req, res) => {
-  const {src, dst} = req.body;
-  try {
-    await apis.movefile(src, dst);
-    res.status(200).send({message: '操作成功！'});
-  } catch (error) {
-    res.status(500).send({message: error.message});
-  }
-};
-```
-
-![move](./move.png)
-
-#### 删除文件（夹）
-
-`rmfile(path)`
-
-```javascript
-export const rmfile = async (req, res) => {
-  const {path} = req.body;
-  try {
-    await apis.rmfile(path);
-    res.status(200).send({message: '操作成功！'});
-  } catch (error) {
-    res.status(500).send({message: error.message});
-  }
-};
-```
-
-![delete](./delete.png)
-
-#### 重命名文件（夹）
-
-`rnfile(path, newpath)`
-
-```javascript
-export const rnfile = async (req, res) => {
-  const {path, newpath} = req.body;
-  try {
-    await apis.rnfile(path, newpath);
-    res.status(200).send({message: '操作成功！'});
-  } catch (error) {
-    res.status(500).send({message: error.message});
-  }
-};
-```
-
-![rename](./rename.png)

No alert changes

Improved metrics

Total package byte prevSize

870254

5629.5%

Number of package files

14

180%

Number of lines in readme file

244

6000%

No dependency changes