blob: 8d9e0213df6f2fd360592862051bc71aa318580c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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
```
|