Function moveSync

  • moveSync(src, dest, options?): void

  • Synchronously moves a file or directory (along with its contents).

    Requires --allow-read and --allow-write permissions.

    Parameters

    • src: string | URL

      The source file or directory as a string or URL.

    • dest: string | URL

      The destination file or directory as a string or URL.

    • Optionaloptions: MoveOptions

      Options for the move operation.

    Returns void

    A void value that returns once the operation completes.

    See

    https://docs.deno.com/runtime/manual/basics/permissions#file-system-access for more information on Deno's permissions system.

    Throws

    If dest already exists and options.overwrite is false.

    Throws

    If src is a sub-directory of dest.

    Example: Basic usage

    import { moveSync } from "@std/fs/move";

    moveSync("./foo", "./bar");

    This will move the file or directory at ./foo to ./bar without overwriting.

    Example: Overwriting

    import { moveSync } from "@std/fs/move";

    moveSync("./foo", "./bar", { overwrite: true });

    This will move the file or directory at ./foo to ./bar, overwriting ./bar if it already exists.

Settings

Member Visibility