rename

function · experimental · requires --allow-read, --allow-write

async function rename(oldpath: string | URL, newpath: string | URL): Promise<void>

Renames (moves) oldpath to newpath. Paths may be files or directories. If newpath already exists and is not a directory, rename() replaces it. OS-specific restrictions may apply when oldpath and newpath are in different directories.

On Unix-like OSes, this operation does not follow symlinks at either path.

It varies between platforms when the operation throws errors, and if so what they are. It's always an error to rename anything to a non-empty directory.

Requires allow-read and allow-write permissions.

oldpath: string | URL

The current name/path of the file/directory.

newpath: string | URL

The updated name/path of the file/directory.

import { rename } from "@ende/fs/unstable-rename";
await rename("old/path", "new/path");