Skip to content

Commit 7ddadd9

Browse files
glasserkevva
authored andcommitted
Add note about filter option
Fixes #57.
1 parent b40549f commit 7ddadd9

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

readme.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ decompress('unicorn.zip', 'dist', {
6666
});
6767
```
6868

69+
*Note that in the current implementation, **`filter` is only applied after fully reading all files from the archive in memory**. Do not rely on this option to limit the amount of memory used by `decompress` to the size of the files included by `filter`. `decompress` will read the entire compressed file into memory regardless.*
70+
6971
##### map
7072

7173
Type: `Function`

0 commit comments

Comments
 (0)