From 7ddadd92139079e520cb822a03fe4260b7db7676 Mon Sep 17 00:00:00 2001 From: David Glasser Date: Mon, 14 Aug 2017 10:45:33 +0200 Subject: [PATCH] Add note about `filter` option Fixes #57. --- readme.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/readme.md b/readme.md index 3855419..1db5f98 100644 --- 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`. `decompress` will read the entire compressed file into memory regardless.* + ##### map Type: `Function`