aboutsummaryrefslogtreecommitdiff
path: root/node_modules/fs-extra/docs/remove-sync.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/fs-extra/docs/remove-sync.md')
-rw-r--r--node_modules/fs-extra/docs/remove-sync.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/node_modules/fs-extra/docs/remove-sync.md b/node_modules/fs-extra/docs/remove-sync.md
new file mode 100644
index 0000000..fb01fe8
--- /dev/null
+++ b/node_modules/fs-extra/docs/remove-sync.md
@@ -0,0 +1,16 @@
+# removeSync(path)
+
+Removes a file or directory. The directory can have contents. Like `rm -rf`.
+
+- `path` `<String>`
+
+## Example:
+
+```js
+const fs = require('fs-extra')
+
+// remove file
+fs.removeSync('/tmp/myfile')
+
+fs.removeSync('/home/jprichardson') // I just deleted my entire HOME directory.
+```