rename

Rename or move a file or directory from oldPath to newPath. Cross-device moves may have platform limits.

Basic usage

import { rename } from '@rush-fs/core'
 
await rename('./old.txt', './new.txt')
await rename('./dir', './renamed-dir')

Methods

rename(oldPath, newPath)

Async. Returns Promise<void>.

renameSync(oldPath, newPath)

Sync. Same arguments; throws on error.

Performance

Single syscall; on par with Node.js. See Benchmarks for single-file behavior.

Notes

• Overwrite: On many platforms newPath can be overwritten if it exists; behavior is platform-dependent (same as Node.js).
• Cross-device: Moving across filesystems may not be supported; copy + delete may be required.