blob: 3afc435b898de008f4baceb5203919e1931290b5 (
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
41
42
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;
});
```
|
