fs.rename(oldPath, newPath, callback)

版本历史
版本变更
v18.0.0

将无效回调传给 callback 参数现在会抛出 ERR_INVALID_ARG_TYPE 而不是 ERR_INVALID_CALLBACK。

v10.0.0

参数 callback 不再是可选的。 不传入它会在运行时抛出 TypeError。

v7.6.0

参数 oldPath 和 newPath 可以是使用 file: 协议的 WHATWG URL 对象。 支持目前仍处于实验阶段。

v7.0.0

参数 callback 不再是可选的。 不传入它将触发 ID 为 DEP0013 的弃用警告。

v0.0.2

新增于: v0.0.2

将 oldPath 处的文件异步重命名为作为 newPath 提供的路径名。 如果 newPath 已经存在，则它将被覆盖。 如果 newPath 是目录，则会引发错误。 除了可能的异常之外，没有为完成回调提供任何参数。

另见: rename(2)。

import { rename } from 'node:fs';

rename('oldFile.txt', 'newFile.txt', (err) => {
  if (err) throw err;
  console.log('Rename complete!');
});
History
VersionChanges
v18.0.0

Passing an invalid callback to the callback argument now throws ERR_INVALID_ARG_TYPE instead of ERR_INVALID_CALLBACK.

v10.0.0

The callback parameter is no longer optional. Not passing it will throw a TypeError at runtime.

v7.6.0

The oldPath and newPath parameters can be WHATWG URL objects using file: protocol. Support is currently still experimental.

v7.0.0

The callback parameter is no longer optional. Not passing it will emit a deprecation warning with id DEP0013.

v0.0.2

Added in: v0.0.2

Asynchronously rename file at oldPath to the pathname provided as newPath. In the case that newPath already exists, it will be overwritten. If there is a directory at newPath, an error will be raised instead. No arguments other than a possible exception are given to the completion callback.

See also: rename(2).

import { rename } from 'node:fs';

rename('oldFile.txt', 'newFile.txt', (err) => {
  if (err) throw err;
  console.log('Rename complete!');
});