@weintek/filesystem

内置的 @weintek/filesystem 模块提供用于执行文件系统操作的功能， 例如创建目录、删除文件和目录。

注意：

  • 该模块仅在本地 HMI 上运行 JS 元件/动作时可用。
Example

创建一个目录并随后删除它

const fs = await import('@weintek/filesystem');
const disk = 'USB1';
const path = 'test';

fs.createDirectory(disk, path);
if (fs.exists(disk, path)) {
    console.log('isDirectory =', fs.isDirectory(disk, path));
    fs.remove(disk, path);
}

Methods

(static) createDirectory(disk, path) → {Boolean}

Since:
  • EasyBuilder Pro V6.09.01

此方法创建一个目录。

请注意，如果父目录不存在，该方法将失败（返回 false）。

Parameters:
Name Type Description
disk String

指定目标磁盘的字符串。可接受的值为 SD、USB1 和 USB2。
path String

指定要创建的目录路径的字符串。
Returns:

如果目录创建成功，则返回 true，否则返回 false。

Type
Boolean

(static) exists(disk, path) → {Boolean}

Since:
  • EasyBuilder Pro V6.09.01

此方法测试指定路径是否存在。

Parameters:
Name Type Description
disk String

指定目标磁盘的字符串。可接受的值为 SD、USB1 和 USB2。
path String

指定要测试的路径的字符串。
Returns:

如果路径存在，则返回 true，否则返回 false。

Type
Boolean

(static) fileSize(disk, path) → {Number}

Since:
  • EasyBuilder Pro V6.09.01

此方法返回文件大小（以字节为单位）。

Parameters:
Name Type Description
disk String

指定目标磁盘的字符串。可接受的值为 SD、USB1 和 USB2。
path String

指定文件路径的字符串。
Returns:

返回文件大小（以字节为单位）。

Type
Number

(static) isDirectory(disk, path) → {Boolean}

Since:
  • EasyBuilder Pro V6.09.01

此方法测试指定路径是否为目录。

Parameters:
Name Type Description
disk String

指定目标磁盘的字符串。可接受的值为 SD、USB1 和 USB2。
path String

指定要测试的路径的字符串。
Returns:

如果路径是目录，则返回 true，否则返回 false。

Type
Boolean

(static) isRegularFile(disk, path) → {Boolean}

Since:
  • EasyBuilder Pro V6.09.01

此方法测试指定路径是否为常规文件。

Parameters:
Name Type Description
disk String

指定目标磁盘的字符串。可接受的值为 SD、USB1 和 USB2。
path String

指定要测试的路径的字符串。
Returns:

如果路径是常规文件，则返回 true，否则返回 false。

Type
Boolean

(static) readdir(disk, path) → {Array.String}

Since:
  • EasyBuilder Pro V6.09.01

此方法返回由 disk 和 path 指定的目录中的文件名列表。

Parameters:
Name Type Description
disk String

指定目标磁盘的字符串。可接受的值为 SD、USB1 和 USB2。
path String

指定目录路径的字符串。
Returns:

返回文件名数组（不包括 . 和 ..）。

Type
Array.String

(static) remove(disk, path) → {Boolean}

Since:
  • EasyBuilder Pro V6.09.01

此方法删除由 disk 和 path 指定的文件或空目录。

Parameters:
Name Type Description
disk String

指定目标磁盘的字符串。可接受的值为 SD、USB1 和 USB2。
path String

指定文件路径的字符串。
Returns:

如果文件被成功删除，则返回 true；如果文件不存在，则返回 false。

Type
Boolean

(static) removeAll(disk, path) → {Number}

Since:
  • EasyBuilder Pro V6.09.01

此方法删除由 disk 和 path 指定的目录及其所有子目录。

Parameters:
Name Type Description
disk String

指定目标磁盘的字符串。可接受的值为 SD、USB1 和 USB2。
path String

指定目录路径的字符串。
Returns:

返回删除的文件和目录的数量。

Type
Number