diff options
Diffstat (limited to 'node_modules/yazl/README.md')
| -rw-r--r-- | node_modules/yazl/README.md | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/node_modules/yazl/README.md b/node_modules/yazl/README.md index ef99f4dc7..a97b8694b 100644 --- a/node_modules/yazl/README.md +++ b/node_modules/yazl/README.md @@ -182,9 +182,6 @@ See `addFile()` for the meaning of `mtime` and `mode`. #### end([options], [finalSizeCallback]) Indicates that no more files will be added via `addFile()`, `addReadStream()`, or `addBuffer()`. -Some time after calling this function, `outputStream` will be ended. Note that this entails that you cannot rely on this -callback to know when you are done producing output. If for instance you are creating a zip archive on disk, you will need -to listen to the `end` event on the `outputStream` before notifying consumers of that file. `options` may be omitted or null and has the following structure and default values: @@ -204,6 +201,9 @@ sometime during or after the call to `end()`. `finalSize` is of type `Number` and can either be `-1` or the guaranteed eventual size in bytes of the output data that can be read from `outputStream`. +Note that `finalSizeCallback` is usually called well before `outputStream` has piped all its data; +this callback does not mean that the stream is done. + If `finalSize` is `-1`, it means means the final size is too hard to guess before processing the input file data. This will happen if and only if the `compress` option is `true` on any call to `addFile()`, `addReadStream()`, or `addBuffer()`, or if `addReadStream()` is called and the optional `size` option is not given. @@ -324,6 +324,8 @@ In order to create empty directories, use `addEmptyDirectory()`. ## Change History + * 2.4.3 + * Clarify readme. [pull #33](https://github.com/thejoshwolfe/yazl/pull/33) * 2.4.2 * Remove octal literals to make yazl compatible with strict mode. [pull #28](https://github.com/thejoshwolfe/yazl/pull/28) * 2.4.1 |