aboutsummaryrefslogtreecommitdiff
path: root/node_modules/fs-extra/docs/move.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/fs-extra/docs/move.md')
-rw-r--r--node_modules/fs-extra/docs/move.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/node_modules/fs-extra/docs/move.md b/node_modules/fs-extra/docs/move.md
new file mode 100644
index 0000000..0dd210c
--- /dev/null
+++ b/node_modules/fs-extra/docs/move.md
@@ -0,0 +1,41 @@
+# move(src, dest, [options, callback])
+
+Moves a file or directory, even across devices.
+
+- `src` `<String>`
+- `dest` `<String>`
+- `options` `<Object>`
+ - `overwrite` `<boolean>`: overwrite existing file or directory, default is `false`.
+- `callback` `<Function>`
+
+## Example:
+
+```js
+const fs = require('fs-extra')
+
+fs.move('/tmp/somefile', '/tmp/does/not/exist/yet/somefile', err => {
+ if (err) return console.error(err)
+
+ console.log('success!')
+})
+
+fs.move('/tmp/somefile', '/tmp/does/not/exist/yet/somefile')
+.then(() => {
+ console.log('success!')
+})
+.catch(err => {
+ console.error(err)
+})
+```
+
+**Using `overwrite` option**
+
+```js
+const fs = require('fs-extra')
+
+fs.move('/tmp/somedir', '/tmp/may/already/existed/somedir', { overwrite: true }, err => {
+ if (err) return console.error(err)
+
+ console.log('success!')
+})
+```