Path.rename() method

pathlib-ts > Path > rename

Path.rename() method

Rename this path to the given target and return the new path instance.

Signature:

rename(target: PathLike): Promise<Path>;

Parameters

Parameter	Type	Description
target	PathLike	Destination path or string.

Returns:

Promise<Path>

Promise resolving to a Path representing the destination.

Remarks

Matches CPython semantics while returning a new Path pointing at the destination.

Example

Renaming build artifacts asynchronously

import { Path } from "pathlib-ts";

const artifact = new Path("./dist/app.tmp");
await artifact.rename("./dist/app.js");