relocate

Relocates a path into a new parent directory.

Example

import { SF } from "@duplojs/server-utils";
import { E, unwrap } from "@duplojs/utils";

const result = await SF.relocate("/tmp/example.txt", "/tmp/archive");
// result: E.Success<string> | SF.FileSystemLeft<"relocate">

if (E.isRight(result)) {
	const newPath = unwrap(result);
	// newPath: string
}

Syntax

function relocate(
  fromPath: string,
  newParentPath: string
): Promise<FileSystemLeft<"relocate"> | E.Success<string>>

Parameters

• fromPath : path to relocate.
• newParentPath : destination parent directory.

Return value

• E.Success<string> : the new path when relocation succeeds.
• FileSystemLeft<"relocate"> : if relocation fails.

See also

• move - Moves a file or directory.
• rename - Renames a file or directory within its parent directory.