小程序开放平台

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

fs.rename

开发
>
JS API
>
文件
>
FileSystemManager
>
rename
>
更新时间:2025-07-23 11:41:52

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

功能描述

重命名文件。可以把文件从 oldPath 移动到 newPath

参数

Object object

属性
类型
默认值
必填
说明
oldPathstring源文件路径,支持本地路径
newPathstring新文件路径,支持本地路径
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

示例代码

javascript
const fs = xhs.getFileSystemManager()

// 异步重命名文件
fs.rename({
  oldPath: `${xhs.env.USER_DATA_PATH}/hello.txt`,
  newPath: `${xhs.env.USER_DATA_PATH}/hello_new.txt`,
  success(res) {
    console.log('文件重命名成功')
  },
  fail(res) {
    console.error('文件重命名失败:', res)
  }
})

// 同步重命名文件
try {
  fs.renameSync(
    `${xhs.env.USER_DATA_PATH}/hello.txt`,
    `${xhs.env.USER_DATA_PATH}/hello_new.txt`
  )
  console.log('文件重命名成功')
} catch(e) {
  console.error('文件重命名失败:', e)
}
该文档是否对您有帮助?