doc update

This commit is contained in:
Cosmin Apreutesei
2017-09-29 22:46:51 +03:00
parent f9642432fc
commit 36e470b9a8
+5 -2
View File
@@ -12,8 +12,11 @@ Returns the zlib version.
### `zlib.deflate(read, write[, bufsize][, format][, level][, windowBits][, memLevel][, strategy])`
* `read` is a reader function `read() -> s[,size] | cdata,size | nil`
* `write` is a writer function `write(cdata, size)`
* `read` is a reader function `read() -> s[,size] | cdata,size | nil`,
but it can also be a string or a table of strings.
* `write` is a writer function `write(cdata, size)`, but it can also be an
empty string (in which case a string with the output is returned) or
an output table (in which case a table with output chunks is returned).
* `bufsize` determines the frequency and size of the writes
* `format` can be:
* 'zlib' - wrap the deflate stream with a zlib header and trailer (default)