mirror of https://github.com/ColorlibHQ/gentelella
41 lines
974 B
Markdown
41 lines
974 B
Markdown
|
---
|
||
|
|
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
|
||
|
|
```
|
||
|
|
|