IO
- 说明:
- IO文件系统函数库 实现多层文件遍历 文件夹遍历 封装常见文件操作函数
函数:
z是否文件(path) → {boolean}
- 说明:
- 这个函数用于判断给定路径是否为文件
- 别名:
-
- IsFile
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要判断的路径 |
返回值:
返回一个布尔值,表示给定路径是否为文件
- Type
- boolean
例子
var isFile = IO.z是否文件('/path/to/file.txt');
console.log(isFile); // true
IsFile(path) → {boolean}
- 说明:
- 这个函数用于判断给定路径是否为文件
- 别名:
-
- z是否文件
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要判断的路径 |
返回值:
返回一个布尔值,表示给定路径是否为文件
- Type
- boolean
例子
var isFile = IO.IsFile('/path/to/file.txt');
console.log(isFile); // true
z是否文件夹(path) → {boolean}
- 说明:
- 这个函数用于判断给定路径是否为文件夹
- 别名:
-
- IsDirectory
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要判断的路径 |
返回值:
返回一个布尔值,表示给定路径是否为文件夹
- Type
- boolean
例子
var isDirectory = IO.z是否文件夹('/path/to/folder');
console.log(isDirectory); // true
IsDirectory(path) → {boolean}
- 说明:
- 这个函数用于判断给定路径是否为文件夹
- 别名:
-
- z是否文件夹
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要判断的路径 |
返回值:
返回一个布尔值,表示给定路径是否为文件夹
- Type
- boolean
例子
var isDirectory = IO.IsDirectory('/path/to/folder');
console.log(isDirectory); // true
z是否隐藏(path) → {boolean}
- 说明:
- 这个函数用于判断给定路径是否为隐藏文件或文件夹
- 别名:
-
- IsHidden
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要判断的路径 |
返回值:
返回一个布尔值,表示给定路径是否为隐藏文件或文件夹
- Type
- boolean
例子
var isHidden = IO.z是否隐藏('/path/to/file.txt');
console.log(isHidden); // false
IsHidden(path) → {boolean}
- 说明:
- 这个函数用于判断给定路径是否为隐藏文件或文件夹
- 别名:
-
- z是否隐藏
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要判断的路径 |
返回值:
返回一个布尔值,表示给定路径是否为隐藏文件或文件夹
- Type
- boolean
例子
var isHidden = IO.IsHidden('/path/to/file.txt');
console.log(isHidden); // false
z文件名(path) → {string}
- 说明:
- 这个函数用于获取给定路径的文件名(不包含路径 带后缀)
- 别名:
-
- getFileName
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要获取文件名的路径 |
返回值:
返回给定路径的纯文件名
- Type
- string
例子
var fileName = IO.z纯文件名('/path/to/file.txt');
console.log(fileName); // 'file'
getFileName(path) → {string}
- 说明:
- 这个函数用于获取给定路径的文件名(不包含路径 带文件后缀)
- 别名:
-
- z纯文件名
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要获取纯文件名的路径 |
返回值:
返回给定路径的文件名
- Type
- string
例子
var fileName = IO.getFileName('/path/to/file.txt');
console.log(fileName); // 'file.txt'
z纯文件名(path) → {string}
- 说明:
- 这个函数用于获取给定路径的文件名(不包含路径 不带后缀)
- 别名:
-
- getFileNameNoType
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要获取文件名的路径 |
返回值:
返回给定路径的文件名
- Type
- string
例子
var fileName = IO.z纯文件名('/path/to/file.txt');
console.log(fileName); // 'file.txt'
getFileNameNoType(path) → {string}
- 说明:
- 这个函数用于获取给定路径的纯文件名(不包含路径和文件后缀)
- 别名:
-
- z纯文件名
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要获取纯文件名的路径 |
返回值:
返回给定路径的纯文件名
- Type
- string
例子
var fileName = IO.getFileName('/path/to/file.txt');
console.log(fileName); // 'file'
z文件后缀(path) → {string}
- 说明:
- 这个函数用于获取给定路径的文件后缀
- 别名:
-
- getFileType
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要获取文件后缀的路径 |
返回值:
返回给定路径的文件后缀
- Type
- string
例子
var fileType = IO.z文件后缀('/path/to/file.txt');
console.log(fileType); // 'txt'
getFileType(path) → {string}
- 说明:
- 这个函数用于获取给定路径的文件后缀
- 别名:
-
- z文件后缀
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要获取文件后缀的路径 |
返回值:
返回给定路径的文件后缀
- Type
- string
例子
var fileType = IO.getFileType('/path/to/file.txt');
console.log(fileType); // 'txt'
z遍历文件(文件夹路径, 遍历子文件opt, 不包含隐藏opt, 结果包含文件夹opt) → {Array}
- 说明:
- 这个函数用于遍历给定文件夹路径下的文件
- 别名:
-
- getFiles
参数列表:
参数名称 | 参数类型 | 属性 | 默认值 | 备注 |
---|---|---|---|---|
文件夹路径 |
string | 要遍历的文件夹路径 | ||
遍历子文件 |
boolean |
<optional> |
false
|
是否遍历子文件夹中的文件 |
不包含隐藏 |
boolean |
<optional> |
true
|
是否包含隐藏文件和文件夹 |
结果包含文件夹 |
boolean |
<optional> |
false
|
遍历结果是否包含文件夹 |
返回值:
返回一个包含文件路径的数组
- Type
- Array
例子
var files = IO.z遍历文件('/path/to/folder', true, true, false);
console.log(files); // ['/path/to/folder/file1.txt', '/path/to/folder/file2.txt']
getFiles(文件夹路径, 遍历子文件opt, 不包含隐藏opt, 结果包含文件夹opt) → {Array}
- 说明:
- 这个函数用于获取给定文件夹路径下的文件
- 别名:
-
- z遍历文件
参数列表:
参数名称 | 参数类型 | 属性 | 默认值 | 备注 |
---|---|---|---|---|
文件夹路径 |
string | 要获取文件的文件夹路径 | ||
遍历子文件 |
boolean |
<optional> |
false
|
是否遍历子文件夹中的文件 |
不包含隐藏 |
boolean |
<optional> |
true
|
是否包含隐藏文件和文件夹 |
结果包含文件夹 |
boolean |
<optional> |
false
|
获取结果是否包含文件夹 |
返回值:
返回一个包含文件路径的数组
- Type
- Array
例子
var files = IO.getFiles('/path/to/folder', true, true, false);
console.log(files); // ['/path/to/folder/file1.txt', '/path/to/folder/file2.txt']
z遍历文件夹(文件夹路径, 遍历子文件opt, 不包含隐藏opt) → {Array}
- 说明:
- 这个函数用于遍历给定文件夹路径下的文件夹
- 别名:
-
- getDirectorys
参数列表:
参数名称 | 参数类型 | 属性 | 默认值 | 备注 |
---|---|---|---|---|
文件夹路径 |
string | 要遍历的文件夹路径 | ||
遍历子文件 |
boolean |
<optional> |
false
|
是否遍历子文件夹中的文件夹 |
不包含隐藏 |
boolean |
<optional> |
true
|
是否包含隐藏文件夹 |
返回值:
返回一个包含文件夹路径的数组
- Type
- Array
例子
var directories = IO.z遍历文件夹('/path/to/folder', true, true);
console.log(directories); // ['/path/to/folder/subfolder1', '/path/to/folder/subfolder2']
getDirectorys(文件夹路径, 遍历子文件opt, 不包含隐藏opt) → {Array}
- 说明:
- 这个函数用于获取给定文件夹路径下的文件夹
- 别名:
-
- z遍历文件夹
参数列表:
参数名称 | 参数类型 | 属性 | 默认值 | 备注 |
---|---|---|---|---|
文件夹路径 |
string | 要获取文件夹的文件夹路径 | ||
遍历子文件 |
boolean |
<optional> |
false
|
是否遍历子文件夹中的文件夹 |
不包含隐藏 |
boolean |
<optional> |
true
|
是否包含隐藏文件夹 |
返回值:
返回一个包含文件夹路径的数组
- Type
- Array
例子
var directories = IO.getDirectorys('/path/to/folder', true, true);
console.log(directories); // ['/path/to/folder/subfolder1', '/path/to/folder/subfolder2']
z上级文件夹(path) → {string}
- 说明:
- 这个函数用于获取给定路径的上级文件夹路径
- 别名:
-
- lastDirectoty
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要获取上级文件夹路径的路径 |
返回值:
返回给定路径的上级文件夹路径
- Type
- string
例子
var parentFolder = IO.z上级文件夹('/path/to/file.txt');
console.log(parentFolder); // '/path/to'
lastDirectoty(路径, 返回级数opt) → {string}
- 说明:
- 这个函数用于获取给定路径的上级文件夹路径
- 别名:
-
- z上级文件夹
参数列表:
参数名称 | 参数类型 | 属性 | 默认值 | 备注 |
---|---|---|---|---|
路径 |
string | 要获取上级文件夹路径的路径 | ||
返回级数 |
number |
<optional> |
1
|
返回上级文件夹的级数 |
返回值:
返回给定路径的上级文件夹路径
- Type
- string
例子
var parentFolder = IO.lastDirectoty('/path/to/file.txt', 2);
console.log(parentFolder); // '/path'
z复制文件(源路径, targetpath) → {string}
- 说明:
- 这个函数用于复制源路径下的文件到目标路径
- 别名:
-
- copyFile
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
源路径 |
string | 要复制的文件路径 |
targetpath |
string | 目标文件路径 |
返回值:
返回复制后的文件路径
- Type
- string
例子
var copiedFile = IO.z复制文件('/path/to/source.txt', '/path/to/target.txt');
console.log(copiedFile); // '/path/to/target.txt'
copyFile(源路径, targetpath) → {boolean}
- 说明:
- 这个函数用于复制源路径下的文件到目标路径
- 别名:
-
- z复制文件
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
源路径 |
string | 要复制的文件路径 |
targetpath |
string | 目标文件路径 |
返回值:
返回一个布尔值,表示复制是否成功
- Type
- boolean
例子
var isCopied = IO.copyFile('/path/to/source.txt', '/path/to/target.txt');
console.log(isCopied); // true
z移动文件(源路径, targetpath) → {undefined}
- 说明:
- 这个函数用于移动源路径下的文件到目标路径
- 别名:
-
- moveFile
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
源路径 |
string | 要移动的文件路径 |
targetpath |
string | 目标文件路径 |
返回值:
无返回值
- Type
- undefined
例子
IO.z移动文件('/path/to/source.txt', '/path/to/target.txt');
moveFile(源路径, targetpath) → {boolean}
- 说明:
- 这个函数用于移动源路径下的文件到目标路径
- 别名:
-
- z移动文件
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
源路径 |
string | 要移动的文件路径 |
targetpath |
string | 目标文件路径 |
返回值:
返回一个布尔值,表示移动是否成功
- Type
- boolean
例子
var isMoved = IO.moveFile('/path/to/source.txt', '/path/to/target.txt');
console.log(isMoved); // true
z重命名(源路径, 新名称) → {undefined}
- 说明:
- 这个函数用于重命名源路径下的文件或文件夹
- 别名:
-
- rename
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
源路径 |
string | 要重命名的文件或文件夹路径 |
新名称 |
string | 新的名称 |
返回值:
无返回值
- Type
- undefined
例子
IO.z重命名('/path/to/file.txt', 'newname.txt');
rename(源路径, 新名称) → {boolean}
- 说明:
- 这个函数用于重命名源路径下的文件或文件夹
- 别名:
-
- z重命名
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
源路径 |
string | 要重命名的文件或文件夹路径 |
新名称 |
string | 新的名称 |
返回值:
返回一个布尔值,表示重命名是否成功
- Type
- boolean
例子
var isRenamed = IO.rename('/path/to/file.txt', 'newname.txt');
console.log(isRenamed); // true
z写入文本文件(路径, 内容) → {undefined}
- 说明:
- 这个函数用于将内容写入指定路径的文本文件中
- 别名:
-
- writefile
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
路径 |
string | 要写入的文本文件路径 |
内容 |
string | 要写入的内容 |
返回值:
无返回值
- Type
- undefined
例子
IO.z写入文本文件('/path/to/file.txt', 'Hello, World!');
writefile(path, content) → {boolean}
- 说明:
- 这个函数用于将内容写入指定路径的文本文件中
- 别名:
-
- z写入文本文件
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要写入的文本文件路径 |
content |
string | 要写入的内容 |
返回值:
返回一个布尔值,表示写入是否成功
- Type
- boolean
例子
var isWritten = IO.writefile('/path/to/file.txt', 'Hello, World!');
console.log(isWritten); // true
z读取文件(路径) → {string}
- 说明:
- 这个函数用于读取指定路径的文件内容
- 别名:
-
- readfile
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
路径 |
string | 要读取的文件路径 |
返回值:
返回文件的内容
- Type
- string
例子
var fileContent = IO.z读取文件('/path/to/file.txt');
console.log(fileContent); // 'Hello, World!'
readfile(path) → {string}
- 说明:
- 这个函数用于读取指定路径的文件内容
- 别名:
-
- z读取文件
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要读取的文件路径 |
返回值:
返回文件的内容
- Type
- string
例子
var fileContent = IO.readfile('/path/to/file.txt');
console.log(fileContent); // 'Hello, World!'
z创建文件夹(path) → {string}
- 说明:
- 创这个函数用于建文件夹
- 别名:
-
- MkDir2
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要创建的文件夹路径 |
返回值:
返回创建的文件夹路径
- Type
- string
例子
var folderPath = IO.z创建文件夹('/path/to/folder');
console.log(folderPath); // '/path/to/folder'
MkDir2(path) → {string}
- 说明:
- 这个函数用于创建文件夹
- 别名:
-
- z创建文件夹
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要创建的文件夹路径 |
返回值:
返回创建的文件夹路径
- Type
- string
例子
var folderPath = IO.MkDir2('/path/to/folder');
console.log(folderPath); // '/path/to/folder'
z删除文件(path) → {undefined}
- 说明:
- 这个函数用于删除指定路径的文件
- 别名:
-
- Delete
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要删除的文件路径 |
返回值:
无返回值
- Type
- undefined
例子
IO.z删除文件('/path/to/file.txt');
Delete(path) → {string}
- 说明:
- 这个函数用于删除指定路径的文件
- 别名:
-
- z删除文件
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要删除的文件路径 |
返回值:
返回被删除的文件路径
- Type
- string
例子
var deletedFile = IO.Delete('/path/to/file.txt');
console.log(deletedFile); // '/path/to/file.txt'
z删除目录(path) → {undefined}
- 说明:
- 这个函数用于删除指定路径的目录
- 别名:
-
- deleteTree
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要删除的目录路径 |
返回值:
无返回值
- Type
- undefined
例子
IO.z删除目录('/path/to/folder');
deleteTree(path) → {boolean}
- 说明:
- 这个函数用于递归删除指定路径的目录及其内容
- 别名:
-
- z删除目录
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要删除的目录路径 |
返回值:
返回一个布尔值,表示删除是否成功
- Type
- boolean
例子
var isDeleted = IO.deleteTree('/path/to/folder');
console.log(isDeleted); // true
z路径斜杠处理(path) → {string}
- 说明:
- 这个函数用于处理路径中的斜杠,将反斜杠转换为正斜杠
- 别名:
-
- correctPath
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要处理的路径 |
返回值:
返回处理后的路径
- Type
- string
例子
var processedPath = IO.z路径斜杠处理('C:\\path\\to\\file.txt');
console.log(processedPath); // 'C:/path/to/file.txt'
correctPath(path) → {string}
- 说明:
- 这个函数用于处理路径中的斜杠,正反斜杠统一为系统环境一样的分隔符样式
- 别名:
-
- z路径斜杠处理
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
string | 要处理的路径 |
返回值:
返回处理后的路径字符串
- Type
- string
例子
var processedPath = IO.correctPath('C:\\path\\to\\file.txt');
console.log(processedPath); // 'C:/path/to/file.txt'
showFileDialog(path) → {String}
- 说明:
- 这个函数用于显示一个文件对话框,返回选择的文件路径
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
String | 显示文件对话框的初始路径 |
返回值:
- 选择的文件路径
- Type
- String
例子
// 示例
showFileDialog('/path/to/file'); // 返回选择的文件路径
showFolderDialog(path) → {String}
- 说明:
- 这个函数用于显示一个文件夹对话框,返回选择的文件夹路径
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
path |
String | 显示文件夹对话框的初始路径 |
返回值:
- 选择的文件夹路径
- Type
- String
例子
// 示例
showFolderDialog('/path/to/folder'); // 返回选择的文件夹路径