aboutsummaryrefslogtreecommitdiff
path: root/node_modules/fs-extra/docs/remove.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/fs-extra/docs/remove.md')
-rw-r--r--node_modules/fs-extra/docs/remove.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/node_modules/fs-extra/docs/remove.md b/node_modules/fs-extra/docs/remove.md
new file mode 100644
index 0000000..3640293
--- /dev/null
+++ b/node_modules/fs-extra/docs/remove.md
@@ -0,0 +1,34 @@
+# remove(path, [callback])
+
+Removes a file or directory. The directory can have contents. Like `rm -rf`.
+
+- `path` `<String>`
+- `callback` `<Function>`
+
+## Example:
+
+```js
+const fs = require('fs-extra')
+
+// remove file
+fs.remove('/tmp/myfile', err => {
+ if (err) return console.error(err)
+
+ console.log('success!')
+})
+
+fs.remove('/home/jprichardson', err => {
+ if (err) return console.error(err)
+
+ console.log('success!') // I just deleted my entire HOME directory.
+})
+
+// Promise Usage
+fs.remove('/tmp/myfile')
+.then(() => {
+ console.log('success!')
+})
+.catch(err => {
+ console.error(err)
+})
+```