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
|
---
title: "generateNodeStream(options[, onUpdate])"
layout: default
section: api
---
Generates the complete zip file as a nodejs stream.
__Returns__ : a [nodejs Streams3](https://github.com/nodejs/readable-stream).
__Since__: v3.0.0
## Arguments
name | type | default | description
--------------------|----------|---------|------------
options | object | | the options to generate the zip file, see [the options of `generateAsync()`]({{site.baseurl}}/documentation/api_jszip/generate_async.html)
onUpdate | function | | The optional function called on each internal update with the metadata.
The `type` parameter has here the default value of `nodebuffer`.
Only `nodebuffer` is currently supported.
__Metadata__ : see [the metadata of `generateAsync()`]({{site.baseurl}}/documentation/api_jszip/generate_async.html#onupdate-callback).
## Examples
```js
zip
.generateNodeStream({streamFiles:true})
.pipe(fs.createWriteStream('out.zip'))
.on('finish', function () {
// JSZip generates a readable stream with a "end" event,
// but is piped here in a writable stream which emits a "finish" event.
console.log("out.zip written.");
});
```
|
