aboutsummaryrefslogtreecommitdiff
path: root/node_modules/fs-extra/docs/move-sync.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2017-05-24 15:10:37 +0200
committerFlorian Dold <florian.dold@gmail.com>2017-05-24 15:11:17 +0200
commit7a3df06eb573d36142bd1a8e03c5ce8752d300b3 (patch)
tree70bfaea8884c374876f607774850a3a51c0cb381 /node_modules/fs-extra/docs/move-sync.md
parentaca1143cb9eed16cf37f04e475e4257418dd18ac (diff)
fix build issues and add typedoc
Diffstat (limited to 'node_modules/fs-extra/docs/move-sync.md')
-rw-r--r--node_modules/fs-extra/docs/move-sync.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/node_modules/fs-extra/docs/move-sync.md b/node_modules/fs-extra/docs/move-sync.md
new file mode 100644
index 000000000..cd701fef9
--- /dev/null
+++ b/node_modules/fs-extra/docs/move-sync.md
@@ -0,0 +1,24 @@
+# moveSync(src, dest, [options])
+
+Moves a file or directory, even across devices.
+
+- `src` `<String>`
+- `dest` `<String>`
+- `options` `<Object>`
+ - `overwrite` `<boolean>`: overwrite existing file or directory, default is `false`.
+
+## Example:
+
+```js
+const fs = require('fs-extra')
+
+fs.moveSync('/tmp/somefile', '/tmp/does/not/exist/yet/somefile')
+```
+
+**Using `overwrite` option**
+
+```js
+const fs = require('fs-extra')
+
+fs.moveSync('/tmp/somedir', '/tmp/may/already/existed/somedir', { overwrite: true })
+```