小程序开放平台

文档中心
基础
路由
跳转
转发
界面
网络
支付
数据缓存
媒体
位置
开放接口
设备
XHSML
性能
第三方平台
文件
removeSavedFile
openDocument
getFileSystemManager
FileSystemManager方法
access
accessSync
appendFile
appendFileSync
copyFile
copyFileSync
getSavedFileList
getFileInfo
mkdir
mkdirSync
readdir
readdirSync
rmdir
rmdirSync
rename
renameSync
readFile
readFileSync
removeSavedFile
stat
statSync
saveFile
saveFileSync
truncate
truncateSync
unlink
unlinkSync
unzip
writeFile
writeFileSync
Stats
FileStats
错误码
数据分析
画布

fs.stat

开发
>
JS API
>
文件
>
FileSystemManager方法
>
stat
>
更新时间:2025-07-23 11:42:05

📌 从基础库 3.125.4 版本开始支持

功能描述

获取文件 Stats 对象

参数

Object object

属性
类型
默认值
必填
说明
最低版本
pathstring文件/目录路径 (本地路径)
recursivebooleanfalse是否递归获取目录下的每个文件的 Stats 信息3.125.4
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调参数

Object res

属性
类型
说明
statsStats/Array.< FileStats >当 recursive 为 false 时返回 Stats 对象;当 recursive 为 true 且 path 是目录路径时返回包含 path 和 stats 的对象数组

示例代码

recursive 为 false 时

javascript
const fs = xhs.getFileSystemManager()

// 异步版本
fs.stat({
  path: `${xhs.env.USER_DATA_PATH}/testDir`,
  success: res => {
    console.log(res.stats.isDirectory())
  }
})

// 同步版本
try {
  const stats = fs.statSync(`${xhs.env.USER_DATA_PATH}/testDir`, false)
  console.log(stats.isDirectory())
} catch(e) {
  console.error(e)
}

recursive 为 true 时

javascript
const fs = xhs.getFileSystemManager()

// 异步版本
fs.stat({
  path: `${xhs.env.USER_DATA_PATH}/testDir`,
  recursive: true,
  success: res => {
    res.stats.forEach(item => {
      console.log(item.path, item.stats.isDirectory())
    })
  }
})

// 同步版本
try {
  const statsList = fs.statSync(`${xhs.env.USER_DATA_PATH}/testDir`, true)
  statsList.forEach(item => {
    console.log(item.path, item.stats.isDirectory())
  })
} catch(e) {
  console.error(e)
}