Merge afb-client

[src/app-framework-demo.git] / afb-client / bower_components / jszip / documentation / api_jszip / remove.md

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 (file)
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
+```
+
+