# fs 文件系统库

## 功能

fs(path) 创建文件系统路径对象，围绕该路径提供读写、复制、移动、删除、目录遍历和路径信息读取能力。

## API 列表

| API | 说明 |
| ------ | ------ |
| [fs.path](/zh-hans/docs/fs/path) | 返回当前 fs 对象绑定的路径文本。 |
| [fs.to_string](/zh-hans/docs/fs/to_string) | 返回当前 fs 对象绑定的路径文本。 |
| [fs.read](/zh-hans/docs/fs/read) | 读取文本文件内容。 |
| [fs.real_path](/zh-hans/docs/fs/real_path) | 返回操作系统解析符号链接和 `..` 后的真实绝对路径。 |
| [fs.binary](/zh-hans/docs/fs/binary) | 读取文件二进制内容。 |
| [fs.lines](/zh-hans/docs/fs/lines) | 按行读取文本文件。 |
| [fs.write](/zh-hans/docs/fs/write) | 覆盖写入文件内容。 |
| [fs.atomic_write](/zh-hans/docs/fs/atomic_write) | 通过同目录临时文件原子替换内容，并可按旧 SHA-256 拒绝冲突。 |
| [fs.append](/zh-hans/docs/fs/append) | 把内容追加到文件末尾。 |
| [fs.prepend](/zh-hans/docs/fs/prepend) | 把内容写到文件开头。 |
| [fs.size](/zh-hans/docs/fs/size) | 读取文件或目录元数据大小。 |
| [fs.rename](/zh-hans/docs/fs/rename) | 把当前路径重命名为目标路径。 |
| [fs.move](/zh-hans/docs/fs/move) | 把当前文件或目录移动到目标目录下，文件名保持不变。 |
| [fs.copy](/zh-hans/docs/fs/copy) | 复制文件或目录到目标路径。 |
| [fs.delete](/zh-hans/docs/fs/delete) | 删除文件或目录。 |
| [fs.create_dir](/zh-hans/docs/fs/create_dir) | 递归创建目录。 |
| [fs.create_file](/zh-hans/docs/fs/create_file) | 创建文件并写入可选初始内容。 |
| [fs.list](/zh-hans/docs/fs/list) | 列出目录项。 |
| [fs.is_dir](/zh-hans/docs/fs/is_dir) | 判断路径是否为目录。 |
| [fs.is_file](/zh-hans/docs/fs/is_file) | 判断路径是否为普通文件。 |
| [fs.is_relative](/zh-hans/docs/fs/is_relative) | 判断当前路径是否为相对路径。 |
| [fs.is_absolute](/zh-hans/docs/fs/is_absolute) | 判断当前路径是否为绝对路径。 |
| [fs.is_symlink](/zh-hans/docs/fs/is_symlink) | 判断路径是否为符号链接。 |
| [fs.is_exists](/zh-hans/docs/fs/is_exists) | 判断路径是否存在。 |
| [fs.basename](/zh-hans/docs/fs/basename) | 返回路径最后一级名称。 |
| [fs.filename](/zh-hans/docs/fs/filename) | 返回路径最后一级名称去掉扩展名后的部分。 |
| [fs.extension](/zh-hans/docs/fs/extension) | 返回路径扩展名。 |

## 示例

```bt
file = fs('demo.txt')
file.write('BT')
result = file.read()

// 输出：BT
print result
```

## 注意事项

- fs() 的路径参数会由 VM 按当前源码目录和项目根规则解析。
- 常驻 Web 服务热路径中应控制同步文件操作耗时。