readSync
API_LEVEL
2.0
开始支持,API 兼容性请参考 API_LEVEL。
同步地从文件句柄指定的文件中读取内容,将内容读取到给定 ArrayBuffer
中。
类型
function readSync(option: Option): Result
参数
Option
属性 | 类型 | 必填 | 默认值 | 说明 | API_LEVEL |
---|---|---|---|---|---|
fd | number | 是 | - | 文件句柄,由 openSync 、openAssetsSync 等 API 返回 | 2.0 |
buffer | ArrayBuffer | 是 | - | 数据将写入的 ArrayBuffer | 2.0 |
options | Options | 否 | - | 其他选项 | 2.0 |
Options
属性 | 类型 | 必填 | 默认值 | 说明 | API_LEVEL |
---|---|---|---|---|---|
offset | number | 否 | 0 | 要写入数据的 buffer 中的位置 | 2.0 |
length | number | 否 | buffer.byteLength | 读取的字节数,默认为传入 buffer 的字节长度 | 2.0 |
position | number|null | 否 | null | 指定从文件中开始读取的位置,如果 position 为 null ,则将从当前文件位置读取数据,并更新文件位置 | 2.0 |
Result
类型 | 说明 |
---|---|
number | 读取的字节数 |
代码示例
import { openSync, readSync, O_RDONLY } from '@zos/fs'
const fd = openSync({
path: 'test.txt',
flag: O_RDONLY,
})
const buffer = new ArrayBuffer(4)
const result = readSync({
fd,
buffer,
})