Filter nested files/folders with the specified function.

Returns : An array of matching ZipObject.

Since: v1.0.0


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, relative to the current folder.
file ZipObject the file being tested. See ZipObject.

The predicate must return true if the file should be included, false otherwise.


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:{...},async:function}
  return true/false;