Document that filter is applied very late

Improves kevva#56, although fixing the issue would be preferable to documenting it.
glasser · Jul 26, 2017 · a382b00 · a382b00
1 parent b40549f
commit a382b00
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/readme.md b/readme.md
@@ -66,6 +66,8 @@ decompress('unicorn.zip', 'dist', {
 });
 ```
 
+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`.
+
 ##### map
 
 Type: `Function`