deno.land / std@0.224.0 / fs / move.ts

View Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.import { isSubdir } from "./_is_subdir.ts";import { isSamePath } from "./_is_same_path.ts";
const EXISTS_ERROR = new Deno.errors.AlreadyExists("dest already exists.");
/** * Error thrown in {@linkcode move} or {@linkcode moveSync} when the * destination is a subdirectory of the source. */export class SubdirectoryMoveError extends Error { /** Constructs a new instance. */ constructor(src: string | URL, dest: string | URL) { super( `Cannot move '${src}' to a subdirectory of itself, '${dest}'.`, ); this.name = this.constructor.name; }}
/** Options for {@linkcode move} and {@linkcode moveSync}. */export interface MoveOptions { /** * Whether the destination file should be overwritten if it already exists. * * @default {false} */ overwrite?: boolean;}
/** * Asynchronously moves a file or directory. * * @param src The source file or directory as a string or URL. * @param dest The destination file or directory as a string or URL. * @param options Options for the move operation. * @returns A void promise that resolves once the operation completes. * * @example Basic usage * ```ts * import { move } from "https://deno.land/std@$STD_VERSION/fs/move.ts"; * * await move("./foo", "./bar"); * ``` * * This will move the file or directory at `./foo` to `./bar` without * overwriting. * * @example Overwriting * ```ts * import { move } from "https://deno.land/std@$STD_VERSION/fs/move.ts"; * * await move("./foo", "./bar", { overwrite: true }); * ``` * * This will move the file or directory at `./foo` to `./bar`, overwriting * `./bar` if it already exists. */export async function move( src: string | URL, dest: string | URL, { overwrite = false }: MoveOptions = {},): Promise<void> { const srcStat = await Deno.stat(src);
if ( srcStat.isDirectory && (isSubdir(src, dest) || isSamePath(src, dest)) ) { throw new SubdirectoryMoveError(src, dest); }
if (overwrite) { if (isSamePath(src, dest)) return; try { await Deno.remove(dest, { recursive: true }); } catch (error) { if (!(error instanceof Deno.errors.NotFound)) { throw error; } } } else { try { await Deno.lstat(dest); return Promise.reject(EXISTS_ERROR); } catch { // Do nothing... } }
await Deno.rename(src, dest);}
/** * Synchronously moves a file or directory. * * @param src The source file or directory as a string or URL. * @param dest The destination file or directory as a string or URL. * @param options Options for the move operation. * @returns A void value that returns once the operation completes. * * @example Basic usage * ```ts * import { moveSync } from "https://deno.land/std@$STD_VERSION/fs/move.ts"; * * moveSync("./foo", "./bar"); * ``` * * This will move the file or directory at `./foo` to `./bar` without * overwriting. * * @example Overwriting * ```ts * import { moveSync } from "https://deno.land/std@$STD_VERSION/fs/move.ts"; * * moveSync("./foo", "./bar", { overwrite: true }); * ``` * * This will move the file or directory at `./foo` to `./bar`, overwriting * `./bar` if it already exists. */export function moveSync( src: string | URL, dest: string | URL, { overwrite = false }: MoveOptions = {},): void { const srcStat = Deno.statSync(src);
if ( srcStat.isDirectory && (isSubdir(src, dest) || isSamePath(src, dest)) ) { throw new SubdirectoryMoveError(src, dest); }
if (overwrite) { if (isSamePath(src, dest)) return; try { Deno.removeSync(dest, { recursive: true }); } catch (error) { if (!(error instanceof Deno.errors.NotFound)) { throw error; } } } else { try { Deno.lstatSync(dest); throw EXISTS_ERROR; } catch (error) { if (error === EXISTS_ERROR) { throw error; } } }
Deno.renameSync(src, dest);}
std

Version Info

Tagged at
6 months ago