search
开发文档
开发文档/小游戏开发/API/文件/文件状态
文件状态更新时间:2025-12-17 15:56:03

Stats

基础信息说明

功能概述:表示文件/目录的状态信息;由 FileSystemManager.stat/statSync 返回

项目说明
版本要求
前提条件通过文件管理器接口获取(不可直接构造)
使用限制同步方法内部会触发底层查询,密集调用需注意性能
相关教程

返回值说明

  • 本对象不直接构造,作为文件管理器 stat/statSync 的返回载体出现

术语约定

  • res 表示异步成功回调的入参对象(fsm.stat({ success(res) { ... } }))
  • return 表示同步调用的返回值对象(const ret = fsm.statSync(path, recursive))

异步(fsm.stat 成功回调)

位置类型说明
res.statsStats对象单个文件或目录的状态对象

提示:如需递归目录统计,请使用同步 statSync。

同步(fsm.statSync 返回值)

位置类型条件说明
return.statsStatsrecursive 未传或为 false;path 指向单个项单个文件或目录的状态对象
return.stats{ [key]: Stats }recursive === true 且 path 为目录递归结果映射:key 以 path 为根路径的相对路径,value 是该路径对应的 Stats 对象

与文件管理器(qg.getFileSystemManager)的关系

维度内容
入口方法
fsm.stat({ path })、fsm.statSync(path, recursive)
构造逻辑无子项列表 → 返回单个 Stats;有子项列表 → 递归生成映射对象 { [key]: Stats }
字段映射底层 length → size,lastAccessedTime 统一为 0
失败形态由文件管理器 fail({ errMsg }) 提供并透传
判断方法isDirectory/isFile 内部调用底层 statSync 判断类型

属性说明

字段名类型说明
modeString文件的类型和存取的权限
sizeNumber文件大小,单位:B
lastAccessedTimeNumber文件最近一次被存取或被执行的时间,UNIX 时间戳
lastModifiedTimeNumber文件最后一次被修改的时间,UNIX 时间戳

方法说明

方法名返回值类型说明
isDirectoryBoolean判断当前文件是否一个目录
isFileBoolean判断当前文件是否一个普通文件

示例代码

// 获取文件管理器
const fsm = qg.getFileSystemManager()

// 异步获取单个文件的状态
fsm.stat({
path: '/data/local/readme.txt',
success(res) {
const stats = res.stats
console.log('size:', stats.size)
console.log('isFile:', stats.isFile())
},
fail(err) {
console.error('read failed:', err)
}
})

注意事项

  • size 源于底层返回的长度字段(适配映射为 length → size)。
  • isDirectory/isFile 内部会触发一次同步状态查,在大量循环中调用时注意性能。
  • 递归形态返回映射对象时,键为底层返回的路径标识,非相对路径字符串。
上一篇:文件管理器
下一篇:地理位置
文档内容是否有帮助?
有帮助
无帮助