diff options
Diffstat (limited to 'node_modules/fs-extra/docs/move-sync.md')
-rw-r--r-- | node_modules/fs-extra/docs/move-sync.md | 24 |
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 0000000..cd701fe --- /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 }) +``` |