Merge afb-client

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

diff --git a/afb-client/bower_components/jszip/documentation/api_jszip/filter.md b/afb-client/bower_components/jszip/documentation/api_jszip/filter.md
new file mode 100644 (file)
index 0000000..3afc435
--- /dev/null
+++ b/afb-client/bower_components/jszip/documentation/api_jszip/filter.md
@@ -0,0 +1,43 @@
+---
+title: "filter(predicate)"
+layout: default
+section: api
+---
+
+__Description__ : Filter nested files/folders with the specified function.
+
+__Arguments__
+
+name      | type     | description
+----------|----------|------------
+predicate | function | the predicate to use.
+
+The predicate has the following signature : `function (relativePath, file) {...}` :
+
+name         | type      | description
+-------------|-----------|------------
+relativePath | string    | the filename and its path, reliatively to the current folder.
+file         | ZipObject | the file being tested. See [ZipObject]({{site.baseurl}}/documentation/api_zipobject.html).
+
+The predicate must return true if the file should be included, false otherwise.
+
+
+__Returns__ : An array of matching ZipObject.
+
+__Throws__ : Nothing.
+
+<!-- __Complexity__ : **O(k)** where k is the number of entries. -->
+
+__Example__
+
+```js
+var zip = new JSZip().folder("dir");
+zip.file("readme.txt", "content");
+zip.filter(function (relativePath, file){
+  // relativePath == "readme.txt"
+  // file = {name:"dir/readme.txt",options:{...},asText:function}
+  return true/false;
+});
+```
+
+