summaryrefslogtreecommitdiffstats
path: root/afb-client/bower_components/jszip/documentation/api_jszip/remove.md
diff options
context:
space:
mode:
authorFulup Ar Foll <fulup@iot.bzh>2016-02-09 18:40:49 +0100
committerFulup Ar Foll <fulup@iot.bzh>2016-02-09 18:40:49 +0100
commit3d2fda7dd39e2363682f1fa353c951ab0d44ddfa (patch)
treeaf968a8ac5d4fde1f3cebcec5fb0973eb2bfb2cb /afb-client/bower_components/jszip/documentation/api_jszip/remove.md
parent12a3520ba440316c76b95d92a684666f03f7b47d (diff)
Implemented URL query parsing for initial token /opa/?token=abcde
Diffstat (limited to 'afb-client/bower_components/jszip/documentation/api_jszip/remove.md')
-rw-r--r--afb-client/bower_components/jszip/documentation/api_jszip/remove.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/afb-client/bower_components/jszip/documentation/api_jszip/remove.md b/afb-client/bower_components/jszip/documentation/api_jszip/remove.md
new file mode 100644
index 0000000..af7aa78
--- /dev/null
+++ b/afb-client/bower_components/jszip/documentation/api_jszip/remove.md
@@ -0,0 +1,37 @@
+---
+title: "remove(name)"
+layout: default
+section: api
+---
+
+__Description__ : Delete a file or folder (recursively).
+
+__Arguments__
+
+name | type | description
+-----|--------|------------
+name | string | the name of the file/folder to delete.
+
+__Returns__ : The current JSZip object.
+
+__Throws__ : Nothing.
+
+<!--
+__Complexity__ : **O(k)** where k is the number of entry to delete (may be > 1
+when removing a folder).
+-->
+
+__Example__
+
+```js
+var zip = new JSZip();
+zip.file("Hello.txt", "Hello World\n");
+zip.file("temp.txt", "nothing").remove("temp.txt");
+// result : Hello.txt
+
+zip.folder("css").file("style.css", "body {background: #FF0000}");
+zip.remove("css");
+//result : empty zip
+```
+
+