Description : Add (or update) a file to the zip file.
Arguments
| name | type | description |
|---|---|---|
| name | string | the name of the file. You can specify folders in the name : the folder separator is a forward slash ("/"). |
| data | String/ArrayBuffer/Uint8Array/Buffer | the content of the file. |
| options | object | the options. |
Content of options :
| name | type | default | description |
|---|---|---|---|
| base64 | boolean | false |
set to true if the data is base64 encoded. For example image data from a <canvas> element. Plain text and HTML do not need this option. |
| binary | boolean | false |
set to true if the data should be treated as raw content, false if this is a text. If base64 is used, this defaults to true, if the data is not a string, this will be set to true. |
| date | date | the current date | the last modification date. |
| compression | string | null | If set, specifies compression method to use for this specific file. If not, the default file compression will be used, see generate(options). |
| optimizedBinaryString | boolean | false |
Set it to true if (and only if) the input is a "binary string" and has already been prepared with a 0xFF mask. |
You shouldn't update the data given to this method : it is kept as it so any update will impact the stored data.
Returns : The current JSZip object, for chaining.
Throws : An exception if the data is not in a supported format.
Example
zip.file("Hello.txt", "Hello World\n");
// base64
zip.file("smile.gif", "R0lGODdhBQAFAIACAAAAAP/eACwAAAAABQAFAAACCIwPkWerClIBADs=", {base64: true});
// from an ajax call with xhr.responseType = 'arraybuffer'
zip.file("smile.gif", arraybufferFromXhr);
// or on nodejs
zip.file("smile.gif", fs.readFileSync("smile.gif"));
zip.file("Xmas.txt", "Ho ho ho !", {date : new Date("December 25, 2007 00:00:01")});
zip.file("folder/file.txt", "file in folder");
zip.file("animals.txt", "dog,platypus\n").file("people.txt", "james,sebastian\n");
// result : Hello.txt, smile.gif, Xmas.txt, animals.txt, people.txt,
// folder/, folder/file.txt