更新文档

master 1.3.0
宇天 2020-01-09 11:44:26 +08:00
parent 61dd8da228
commit 5c66a1b883
1 changed files with 21 additions and 21 deletions

View File

@ -11,18 +11,18 @@
+ props + props
- [origin](#origin) - [origin](#origin)
+ methods + methods
- [.cat(file)](#.catfile) - [.cat(file)](#catfile)
- [.ls(path, recursive)](#.lspath-recursive) - [.ls(path, recursive)](#lspath-recursive)
- [.echo(data, file, append, encode)](#.echodata-file-append-encode) - [.echo(data, file, append, encode)](#echodata-file-append-encode)
- [.chmod(path, mode)](#.chmodpath-mode) - [.chmod(path, mode)](#chmodpath-mode)
- [.chown(path, uid, gid)](#.chownpath-uid-gid) - [.chown(path, uid, gid)](#chownpath-uid-gid)
- [.mv(origin, target)](#.mvorigin-target) - [.mv(origin, target)](#mvorigin-target)
- [.cp(origin, target)](#.cporigin-target) - [.cp(origin, target)](#cporigin-target)
- [.rm(origin)](#.rmorigin) - [.rm(origin)](#rmorigin)
- [.stat(path)](#.statpath) - [.stat(path)](#statpath)
- [.isdir(path)](#.isdirpath) - [.isdir(path)](#isdirpath)
- [.mkdir(dir, mode)](#.mkdirdir-mode) - [.mkdir(dir, mode)](#mkdirdir-mode)
- [.exists(path)](#.existspath) - [.exists(path)](#existspath)
## 属性 ## 属性
@ -76,7 +76,7 @@ fs.echo('world', 'test.txt', true) // 不会覆盖, 只会追加到 test.txt中
--- ---
### chmod(path, mode) ### .chmod(path, mode)
> 修改文件&目录的权限. > 修改文件&目录的权限.
| 参数 | 类型 | 是否必须 | 说明 | | 参数 | 类型 | 是否必须 | 说明 |
@ -94,7 +94,7 @@ fs.chmod('test.txt', 0o777)
--- ---
### chown(path, uid, gid) ### .chown(path, uid, gid)
> 修改文件&目录的归属。 > 修改文件&目录的归属。
| 参数 | 类型 | 是否必须 | 说明 | | 参数 | 类型 | 是否必须 | 说明 |
@ -110,7 +110,7 @@ fs.chmod('test.txt', 0o777)
### mv(origin, target) ### .mv(origin, target)
> 移动文件&目录, 支持跨磁盘移动; 同时具备重命名功能。 > 移动文件&目录, 支持跨磁盘移动; 同时具备重命名功能。
| 参数 | 类型 | 是否必须 | 说明 | | 参数 | 类型 | 是否必须 | 说明 |
@ -122,7 +122,7 @@ fs.chmod('test.txt', 0o777)
--- ---
### cp(origin, target) ### .cp(origin, target)
> 复制文件&目录, 支持跨磁盘复制。 > 复制文件&目录, 支持跨磁盘复制。
| 参数 | 类型 | 是否必须 | 说明 | | 参数 | 类型 | 是否必须 | 说明 |
@ -134,7 +134,7 @@ fs.chmod('test.txt', 0o777)
--- ---
### rm(origin) ### .rm(origin)
> 删除文件&目录 > 删除文件&目录
| 参数 | 类型 | 是否必须 | 说明 | | 参数 | 类型 | 是否必须 | 说明 |
@ -153,7 +153,7 @@ fs.rm('./foo') // 整个目录删除
### stat(path) ### .stat(path)
> 返回文件&目录的状态信息, 如修改时间, 文件大小等 > 返回文件&目录的状态信息, 如修改时间, 文件大小等
| 参数 | 类型 | 是否必须 | 说明 | | 参数 | 类型 | 是否必须 | 说明 |
@ -166,7 +166,7 @@ fs.rm('./foo') // 整个目录删除
--- ---
### isdir(path) ### .isdir(path)
> 判断指定目录是否为一个目录, 路径不存在或者不是目录都会返回 false. > 判断指定目录是否为一个目录, 路径不存在或者不是目录都会返回 false.
| 参数 | 类型 | 是否必须 | 说明 | | 参数 | 类型 | 是否必须 | 说明 |
@ -175,7 +175,7 @@ fs.rm('./foo') // 整个目录删除
--- ---
### mkdir(dir) ### .mkdir(dir)
> 创建目录, 会自动创建上级目录(如不存在) > 创建目录, 会自动创建上级目录(如不存在)
| 参数 | 类型 | 是否必须 | 说明 | | 参数 | 类型 | 是否必须 | 说明 |
@ -185,7 +185,7 @@ fs.rm('./foo') // 整个目录删除
--- ---
### exists(path) ### .exists(path)
> 判断文件&目录是否存在 > 判断文件&目录是否存在
| 参数 | 类型 | 是否必须 | 说明 | | 参数 | 类型 | 是否必须 | 说明 |