gentelella/vendors/jszip/documentation/api_jszip/file_regex.md

1.3 KiB

title layout section
file(regex) default api

Description : Search a file in the current folder and subfolders with a regular expression. The regex is tested against the relative filename.

Arguments

name type description
regex RegExp the regex to use.

Returns : An array of matching files (an empty array if none matched). Each maching file is an instance of ZipObject.

Throws : Nothing.

Example

var zip = new JSZip();
zip.file("file1.txt", "content");
zip.file("file2.txt", "content");

zip.file(/file/); // array of size 2

// example with a relative path :
var folder = zip.folder("sub");
folder
  .file("file3.txt", "content")  // relative path from folder : file3.txt
  .file("file4.txt", "content"); // relative path from folder : file4.txt

folder.file(/file/);  // array of size 2
folder.file(/^file/); // array of size 2, the relative paths start with file

// arrays contain objects in the form:
// {name: "file2.txt", dir: false, asText : function () {...}, ...}