summaryrefslogtreecommitdiffstats
path: root/afm-client/bower_components/jszip/documentation/api_jszip/folder_regex.md
diff options
context:
space:
mode:
authorFulup Ar Foll <fulup@iot.bzh>2016-01-28 16:30:12 +0100
committerFulup Ar Foll <fulup@iot.bzh>2016-01-28 16:30:12 +0100
commitbe83a8f382cf2fea98161bfd6d51719aacbf9aa9 (patch)
tree3fb02337f8d7d308ef7ca7818ecc3d3a6ee05d88 /afm-client/bower_components/jszip/documentation/api_jszip/folder_regex.md
parent1a4ed39bf86b2115eb0f1387d1e988462b492776 (diff)
Update JSON API
Diffstat (limited to 'afm-client/bower_components/jszip/documentation/api_jszip/folder_regex.md')
-rw-r--r--afm-client/bower_components/jszip/documentation/api_jszip/folder_regex.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/afm-client/bower_components/jszip/documentation/api_jszip/folder_regex.md b/afm-client/bower_components/jszip/documentation/api_jszip/folder_regex.md
new file mode 100644
index 0000000..8d9e021
--- /dev/null
+++ b/afm-client/bower_components/jszip/documentation/api_jszip/folder_regex.md
@@ -0,0 +1,40 @@
+---
+title: "folder(regex)"
+layout: default
+section: api
+---
+
+__Description__ : Search a subdirectory in the current directory with a
+[regular expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions).
+The regex is tested against the relative path.
+
+__Arguments__
+
+name | type | description
+------|--------|------------
+regex | RegExp | the regex to use.
+
+__Returns__ : An array of matching folders (an empty array if none matched).
+Each maching folder is an instance of [ZipObject]({{site.baseurl}}/documentation/api_zipobject.html).
+
+__Throws__ : Nothing.
+
+<!--
+__Complexity__ : **O(k)** where k is the number of entries in the current JSZip
+instance.
+-->
+
+__Example__
+
+```js
+var zip = new JSZip();
+zip.folder("home/Pierre/videos");
+zip.folder("home/Pierre/photos");
+zip.folder("home/Jean/videos");
+zip.folder("home/Jean/photos");
+
+zip.folder(/videos/); // array of size 2
+
+zip.folder("home/Jean").folder(/^vid/); // array of 1
+```
+