重命名文件或文件夹

fs.rename(Promise异步返回)

rename(oldPath: string, newPath: string): Promise

重命名文件或文件夹，使用Promise异步返回。

说明： 该接口不支持在分布式文件路径下操作。

原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。

参数：

参数名	类型	必填	说明
oldPath	string	是	文件的应用沙箱原路径。
newPath	string	是	文件的应用沙箱新路径。

返回值：

类型	说明
Promise	Promise对象。无返回值。

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

import { BusinessError } from '@kit.BasicServicesKit';
let srcFile = pathDir + "/test.txt";
let dstFile = pathDir + "/new.txt";
fs.rename(srcFile, dstFile).then(() => {
  console.info("rename succeed");
}).catch((err: BusinessError) => {
  console.error("rename failed with error message: " + err.message + ", error code: " + err.code);
});

fs.rename(Callback异步返回)

rename(oldPath: string, newPath: string, callback: AsyncCallback): void

重命名文件或文件夹，使用callback异步回调。

说明： 该接口不支持在分布式文件路径下操作。

原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。

参数：

参数名	类型	必填	说明
oldPath	string	是	文件的应用沙箱原路径。
newPath	string	是	文件的应用沙箱新路径。
callback	AsyncCallback	是	异步重命名文件之后的回调。

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

import { BusinessError } from '@kit.BasicServicesKit';
let srcFile = pathDir + "/test.txt";
let dstFile = pathDir + "/new.txt";
fs.rename(srcFile, dstFile, (err: BusinessError) => {
  if (err) {
    console.error("rename failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("rename succeed");
  }
});

fs.renameSync(同步)

renameSync(oldPath: string, newPath: string): void

以同步方法重命名文件或文件夹。

说明： 该接口不支持在分布式文件路径下操作。

原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。

参数：

参数名	类型	必填	说明
oldPath	string	是	文件的应用沙箱原路径。
newPath	string	是	文件的应用沙箱新路径。

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

let srcFile = pathDir + "/test.txt";
let dstFile = pathDir + "/new.txt";
fs.renameSync(srcFile, dstFile);