Skip to main content
版本:v3

readSync

API_LEVEL 2.0 开始支持,API 兼容性请参考 API_LEVEL

同步地从文件句柄指定的文件中读取内容,将内容读取到给定 ArrayBuffer 中。

类型

function readSync(option: Option): Result

参数

Option

属性类型必填默认值说明API_LEVEL
fdnumber-文件句柄,由 openSyncopenAssetsSync 等 API 返回2.0
bufferArrayBuffer-数据将写入的 ArrayBuffer2.0
optionsOptions-其他选项2.0

Options

属性类型必填默认值说明API_LEVEL
offsetnumber0要写入数据的 buffer 中的位置2.0
lengthnumberbuffer.byteLength读取的字节数,默认为传入 buffer 的字节长度2.0
positionnumber|nullnull指定从文件中开始读取的位置,如果 positionnull,则将从当前文件位置读取数据,并更新文件位置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,
})